{"id":23120495,"url":"https://github.com/typescriptlibs/tsl-apple-cloudkit","last_synced_at":"2025-06-26T16:33:09.977Z","repository":{"id":37470258,"uuid":"133243327","full_name":"typescriptlibs/tsl-apple-cloudkit","owner":"typescriptlibs","description":"TypeScript Library for Apple CloudKit JS","archived":false,"fork":false,"pushed_at":"2024-09-29T07:41:47.000Z","size":11630,"stargazers_count":25,"open_issues_count":2,"forks_count":4,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-05-27T14:24:04.437Z","etag":null,"topics":["apple","cloudkit","typescript"],"latest_commit_sha":null,"homepage":"https://typescriptlibs.org/tsl-apple-cloudkit/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/typescriptlibs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-13T14:14:32.000Z","updated_at":"2025-02-07T05:12:24.000Z","dependencies_parsed_at":"2024-08-12T15:31:56.071Z","dependency_job_id":null,"html_url":"https://github.com/typescriptlibs/tsl-apple-cloudkit","commit_stats":{"total_commits":108,"total_committers":3,"mean_commits":36.0,"dds":"0.17592592592592593","last_synced_commit":"e8e5261ef0979a14e412470c58553094e970bcff"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/typescriptlibs/tsl-apple-cloudkit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typescriptlibs%2Ftsl-apple-cloudkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typescriptlibs%2Ftsl-apple-cloudkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typescriptlibs%2Ftsl-apple-cloudkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typescriptlibs%2Ftsl-apple-cloudkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/typescriptlibs","download_url":"https://codeload.github.com/typescriptlibs/tsl-apple-cloudkit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typescriptlibs%2Ftsl-apple-cloudkit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262102309,"owners_count":23259236,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apple","cloudkit","typescript"],"created_at":"2024-12-17T06:11:19.195Z","updated_at":"2025-06-26T16:33:09.936Z","avatar_url":"https://github.com/typescriptlibs.png","language":"TypeScript","readme":"Apple CloudKit TypeScript Library\n=================================\n\nTypeScript library with type declarations of Apple CloudKit JS v2. It downloads\nthe CloudKit JS file automatically from the Apple CDN during NPM installation.\n\n\n\n[![CodeQL](https://github.com/typescriptlibs/tsl-apple-cloudkit/workflows/CodeQL/badge.svg)](https://github.com/typescriptlibs/tsl-apple-cloudkit/actions/workflows/codeql.yml)\n[![Node.js](https://github.com/typescriptlibs/tsl-apple-cloudkit/workflows/Node.js/badge.svg)](https://github.com/typescriptlibs/tsl-apple-cloudkit/actions/workflows/node.js.yml)\n[![npm](https://img.shields.io/npm/v/tsl-apple-cloudkit.svg)](https://www.npmjs.com/package/tsl-apple-cloudkit)\n[![license](https://img.shields.io/npm/l/tsl-apple-cloudkit.svg)](https://github.com/typescriptlibs/tsl-apple-cloudkit/blob/main/LICENSE.md)\n\n\n\nChanges\n-------\n\nPlease note, that starting with v0.2.7 some elements break with the\ndocumentation by Apple. The following changes have been made:\n\n- Container.registerForNotifications actually returns a Promise\n\n- Use ContainerConfigLike, ClientContainerConfig, and ServerContainerConfig\n  instead of ContainerConfig\n\n- Use FilterLike, RecordFieldFilter, and SystemFieldFilter instead of Filter\n\n- Use RecordLike, RecordReceived, RecordToChange, and RecordToCreate instead of\n  Record\n\n- Share extends RecordReceived\n\n- Use SortDescriptorLike, RecordFieldSortDescriptor, and\n  SystemFieldSortDescriptor instead of SortDescriptor\n\n\n\nRequirements\n------------\n\nThis package is officially compatible with\n\n- CloudKit JS 2.0 and later\n\n- Node.js 16.0 and later (server)\n\n- RequireJS 2.0 and later (client)\n\n- TypeScript 3.0 and later (development)\n\nEarlier versions might work as well, but do not receive updates anymore.\n\n\n\nInstallation \u0026 Update\n---------------------\n\n```Shell\nnpm i https://typescriptlibs.org/npm/tsl-apple-cloudkit.tgz\n```\n\n\n\nConfiguration\n-------------\n\nOn client side you can configure RequireJS to find the client handler, that has\nto be moved outside the NodeJS package:\n\n```JavaScript\nrequire.config({\n\tpaths: {\n\t\t'tsl-apple-cloudkit': 'lib/tsl-apple-cloudkit',\n\t}\n});\n```\n\nPlease note: If you do not create a bundle containing `tsl-apple-cloudkit`, the\nhandler requires a static reference to CloudKit JS in the HTML head like this:\n\n```HTML\n\u003cscript src=\"https://cdn.apple-cloudkit.com/ck/2/cloudkit.js\"\u003e\u003c/script\u003e\n```\n\nThere are reports that CloudKit JS might not be compatible with the bundler of\nAngular v13 and later.\n\n\n\nUsage\n-----\n\nYou can use the CloudKit JS library simply as a regular module:\n\n```TypeScript\nimport * as CloudKit from 'tsl-apple-cloudkit';\n```\n\nOr you reference the CloudKit JS declarations directly, when you use no modules:\n\n```TypeScript\n/// \u003creference path=\"node_modules/tsl-apple-cloudkit/index.d.ts\" /\u003e\n```\n\n\n\nDocumentation\n-------------\n\nFurther information can be found in the\n[Apple CloudKit JS Documentation](https://developer.apple.com/documentation/cloudkitjs),\n[Apple CloudKit JS Video](https://developer.apple.com/videos/play/wwdc2015/710/),\nand [Apple iCloud Development](https://developer.apple.com/icloud/).\n\nUse [Apple CKTool JS](https://www.npmjs.com/package/@apple/cktool.database)\nand [Apple CKTool JS Reference](https://developer.apple.com/documentation/cktooljs)\nto manage CloudKit containers and databases.\n\n\n\nLegal Notes\n-----------\n\nThe downloaded index.js is licensed only for use to Apple developers in\nproviding CloudKit Web Services, or any part thereof, and is subject to the\niCloud Terms and Conditions and the Apple Developer Program License Agreement.\nYou may not port this file to another platform inconsistent with the iCloud\nTerms and Conditions, the Apple Developer Program License Agreement, or the\naccompanying Documentation without Apple's written consent.\n\nAcknowledgements: https://cdn.apple-cloudkit.com/ck/2/acknowledgements.txt\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypescriptlibs%2Ftsl-apple-cloudkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypescriptlibs%2Ftsl-apple-cloudkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypescriptlibs%2Ftsl-apple-cloudkit/lists"}