Apple CloudKit TypeScript Library

TypeScript library with type declarations of Apple CloudKit JS v2. It downloads the CloudKit JS file automatically from the Apple CDN during NPM installation.

CodeQL Node.js npm license


Please note, that starting with v0.2.7 some elements break with the documentation by Apple. The following changes have been made:

  • Container.registerForNotifications actually returns a Promise

  • Use ContainerConfigLike, ClientContainerConfig, and ServerContainerConfig instead of ContainerConfig

  • Use FilterLike, RecordFieldFilter, and SystemFieldFilter instead of Filter

  • Use RecordLike, RecordReceived, RecordToChange, and RecordToCreate instead of Record

  • Share extends RecordReceived

  • Use SortDescriptorLike, RecordFieldSortDescriptor, and SystemFieldSortDescriptor instead of SortDescriptor


This package is compatible to

  • CloudKit JS 2.0 and later

  • Node.js 14.0 and later (server)

  • RequireJS 2.0 and later (client)

  • TypeScript 2.0 and later (development)

Installation & Update

npm i


On client side you can configure RequireJS to find the client handler, that has to be moved outside the NodeJS package:

	paths: {
		'tsl-apple-cloudkit': 'libs/tsl-apple-cloudkit',

Please note: If you do not create a bundle containg tsl-apple-cloudkit, the handler requires a static reference to CloudKit JS in the HTML head like this:

<script src="" />


You can use the CloudKit JS simply as a regular module:

import * as CloudKit from 'tsl-apple-cloudkit';

Or you reference the CloudKit JS declarations directly, when you use no modules:

/// <reference path="node_modules/tsl-apple-cloudkit/index.d.ts" />


Further information can be found in the Apple CloudKit JS Reference, Apple CloudKit JS Video, and Apple iCloud Development.

Use Apple CKTool JS and Apple CKTool JS Reference to manage CloudKit containers and databases.

The downloaded main.js is licensed only for use to Apple developers in providing CloudKit Web Services, or any part thereof, and is subject to the iCloud Terms and Conditions and the Apple Developer Program License Agreement. You may not port this file to another platform inconsistent with the iCloud Terms and Conditions, the Apple Developer Program License Agreement, or the accompanying Documentation without Apple’s written consent.