@atlasauth/types 0.1.0 → 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,32 @@
+# @atlasauth/types changelog
+
+## 0.3.0
+
+### Added
+
+- `User.version` (optional): strictly increases with every change to the user; user webhook payloads carry the same value.
+
+## 0.2.0
+
+### Added
+
+- `WebhookEvent` gains `api_key.created`, `api_key.updated` and
+  `api_key.limit_reached`.
+- `WebhookEvent` gains `entitlement.override.created`,
+  `entitlement.override.deleted` and `entitlement.override.expired`, which the
+  server already emitted but the union was missing.
+- `DesignTokens` gains optional `colorTextOnPrimary` and `colorFocusRing` (mirrors `@atlasauth/react` 0.5.0).
+
+## 0.1.0
+
+First published release.
+
+### Added
+- Dependency-free, runtime-free shared TypeScript types for Atlas integrators; every export is type-only, so importing them adds nothing to a bundle.
+- Session: `SessionClaims`, including the `orgs` entries' optional `settings_partial` flag, set when some organization settings could not be included in the token and should be fetched instead.
+- Authorization: `AuthzClaims`, `ProtectCondition`, `ProtectOutcome`, `ProtectReason`.
+- Verification: `VerifiedSessionClaims`, `AuthorizedSession`, `VerifyResult`.
+- Backend API resources: `User`, `EmailAddress`, `Session`, `Organization`, `OrganizationMembership`, `Invitation`, `ApiKey`, `ApiKeySubjectType`, `ApiKeyVerification`, and the `Metadata`, `CursorPage`, `DataList`, `CursorParams` and `DeletedObject` envelopes.
+- Webhooks: `WebhookEvent`, `WebhookPayload`, `WebhookVerifyResult`, `WebhookVerifyFailure`.
+- Theming and localization: `Appearance`, `DesignTokens`, `ElementKey`, `LocalizationResource`, `Localization`, `DeepPartial`.
+

package/dist/appearance.d.ts

@@ -16,6 +16,10 @@ export interface DesignTokens {
     borderRadius?: string;
     fontFamily?: string;
     spacingUnit?: string;
+    /** Text/icon colour on a `colorPrimary` fill. Defaults to a contrast-picked white or near-black. */
+    colorTextOnPrimary?: string;
+    /** The keyboard focus ring (solid outline). Defaults to `colorPrimary`. */
+    colorFocusRing?: string;
 }
 /** Every element a customer may target. Named for what it IS, not where it sits. */
 export type ElementKey = 'root' | 'card' | 'headerTitle' | 'headerSubtitle' | 'formField' | 'formFieldLabel' | 'formFieldInput' | 'formFieldError' | 'formButtonPrimary' | 'formButtonSecondary' | 'socialButton' | 'dividerText' | 'footerAction' | 'avatar' | 'menu' | 'menuItem' | 'badge';

package/dist/resources.d.ts

@@ -51,6 +51,12 @@ export interface User {
     last_sign_in_at: number | null;
     created_at: number;
     updated_at: number;
+    /**
+     * Strictly increases with every change to the user; user webhook payloads
+     * carry the same value. Apply an update only if its version is higher than
+     * the one you hold. (Absent from servers older than this field.)
+     */
+    version?: number;
 }
 export interface EmailAddress {
     object: 'email_address';

package/dist/session.d.ts

@@ -60,6 +60,14 @@ export interface SessionClaims {
         role: string;
         plan?: string;
         pub?: Record<string, unknown>;
+        /**
+         * §round-8 #2 set to `true` when an allowlisted settings key that IS set for
+         * this org could not be inlined (non-primitive, or over the token byte budget).
+         * It marks the inline settings subset as INCOMPLETE — do not treat a key's
+         * absence as "unset"; fetch the authoritative settings. Absent when nothing was
+         * dropped.
+         */
+        settings_partial?: true;
     }>;
     /**
      * §P1-6 the structured billing entitlement — `{ plan, features, limits }` —

package/dist/webhooks.d.ts

@@ -10,7 +10,7 @@
 /**
  * §12.1 event catalog — the exact union off core's `WEBHOOK_EVENTS`.
  */
-export type WebhookEvent = 'user.created' | 'user.updated' | 'user.deleted' | 'user.banned' | 'user.unbanned' | 'user.locked' | 'user.deactivated' | 'user.graduated' | 'policy.imposed' | 'user.suspended' | 'user.unsuspended' | 'session.created' | 'session.revoked' | 'session.ended' | 'session.pending' | 'session.removed' | 'grant.revoked' | 'email.created' | 'sms.created' | 'organization.created' | 'organization.updated' | 'organization.deleted' | 'organizationMembership.created' | 'organizationMembership.updated' | 'organizationMembership.deleted' | 'organization.membership.deleted' | 'organizationInvitation.created' | 'organizationInvitation.accepted' | 'organizationInvitation.revoked' | 'organizationInvitation.declined' | 'role.created' | 'role.updated' | 'role.deleted' | 'permission.created' | 'permission.updated' | 'permission.deleted' | 'organizationDomain.created' | 'organizationDomain.updated' | 'organizationDomain.deleted' | 'organization.settings.updated' | 'waitlistEntry.created' | 'waitlistEntry.updated' | 'subscription.created' | 'subscription.updated' | 'subscription.deleted' | 'entitlement.created' | 'entitlement.updated' | 'entitlement.deleted' | 'scimToken.created' | 'scimToken.revoked' | 'api_key.revoked' | 'ssoConnection.created' | 'ssoConnection.updated' | 'ssoConnection.deleted' | 'user.data_export.requested' | 'user.deletion_requested' | 'user.deletion_cancelled' | 'data_subject_request.scheduled' | 'data_subject_request.fulfilled' | 'data_subject_request.rejected' | 'machine.enrolled' | 'machine.revoked' | 'machine.updated' | 'user.deletion_scheduled' | 'user.deletion_canceled';
+export type WebhookEvent = 'user.created' | 'user.updated' | 'user.deleted' | 'user.banned' | 'user.unbanned' | 'user.locked' | 'user.deactivated' | 'user.graduated' | 'policy.imposed' | 'user.suspended' | 'user.unsuspended' | 'session.created' | 'session.revoked' | 'session.ended' | 'session.pending' | 'session.removed' | 'grant.revoked' | 'email.created' | 'sms.created' | 'organization.created' | 'organization.updated' | 'organization.deleted' | 'organizationMembership.created' | 'organizationMembership.updated' | 'organizationMembership.deleted' | 'organization.membership.deleted' | 'organizationInvitation.created' | 'organizationInvitation.accepted' | 'organizationInvitation.revoked' | 'organizationInvitation.declined' | 'role.created' | 'role.updated' | 'role.deleted' | 'permission.created' | 'permission.updated' | 'permission.deleted' | 'organizationDomain.created' | 'organizationDomain.updated' | 'organizationDomain.deleted' | 'organization.settings.updated' | 'waitlistEntry.created' | 'waitlistEntry.updated' | 'subscription.created' | 'subscription.updated' | 'subscription.deleted' | 'entitlement.created' | 'entitlement.updated' | 'entitlement.deleted' | 'entitlement.override.created' | 'entitlement.override.deleted' | 'entitlement.override.expired' | 'scimToken.created' | 'scimToken.revoked' | 'api_key.revoked' | 'api_key.created' | 'api_key.updated' | 'api_key.limit_reached' | 'ssoConnection.created' | 'ssoConnection.updated' | 'ssoConnection.deleted' | 'user.data_export.requested' | 'user.deletion_requested' | 'user.deletion_cancelled' | 'data_subject_request.scheduled' | 'data_subject_request.fulfilled' | 'data_subject_request.rejected' | 'machine.enrolled' | 'machine.revoked' | 'machine.updated' | 'user.deletion_scheduled' | 'user.deletion_canceled';
 /**
  * §12.2 payload. Full resource objects, not diffs — "consumers never need a
  * read-back call", which also means a consumer processing events out of order

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlasauth/types",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Shared public TypeScript types for Atlas — the Atlas peer of @clerk/types. Dependency-free, runtime-free: import type { User } from '@atlasauth/types' pulls in no runtime SDK.",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -11,14 +11,15 @@
   },
   "devDependencies": {
     "typescript": "^5.6.3",
-    "@atlasauth/localizations": "0.1.0"
+    "@atlasauth/localizations": "0.6.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "tsc -p tsconfig.build.json",