@getrheo/contracts 1.0.0

package/dist/sdkAttributes.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Reserved SDK attribute keys that the SDK writes automatically during a
+ * flow run. They bypass the manifest's `sdkAttributeKeys` allowlist when
+ * referenced from decision nodes so authors can branch on provider state
+ * without having to declare each key up front.
+ */
+declare const RESERVED_RC_SDK_KEYS: readonly ["onb_rc_last_event", "onb_rc_last_product_id", "onb_rc_last_period_type", "onb_rc_last_offering_id"];
+type ReservedRcSdkKey = (typeof RESERVED_RC_SDK_KEYS)[number];
+declare const isReservedSdkKey: (key: string) => key is ReservedRcSdkKey;
+
+export { RESERVED_RC_SDK_KEYS, type ReservedRcSdkKey, isReservedSdkKey };

package/dist/sdkAttributes.js

@@ -0,0 +1,17 @@
+// src/sdkAttributes.ts
+var RESERVED_RC_SDK_KEYS = [
+  /** Last RC event observed by the SDK (e.g. `purchase_completed`, `purchase_cancelled`). */
+  "onb_rc_last_event",
+  /** Product identifier from the most recent successful purchase. */
+  "onb_rc_last_product_id",
+  /** Period type (`normal`, `intro`, `trial`) from the most recent purchase. */
+  "onb_rc_last_period_type",
+  /** RevenueCat offering id surfaced by the most recent paywall presentation. */
+  "onb_rc_last_offering_id"
+];
+var RESERVED_SDK_KEYS_SET = new Set(RESERVED_RC_SDK_KEYS);
+var isReservedSdkKey = (key) => RESERVED_SDK_KEYS_SET.has(key);
+
+export { RESERVED_RC_SDK_KEYS, isReservedSdkKey };
+//# sourceMappingURL=sdkAttributes.js.map
+//# sourceMappingURL=sdkAttributes.js.map

package/dist/sdkAttributes.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/sdkAttributes.ts"],"names":[],"mappings":";AAMO,IAAM,oBAAA,GAAuB;AAAA;AAAA,EAElC,mBAAA;AAAA;AAAA,EAEA,wBAAA;AAAA;AAAA,EAEA,yBAAA;AAAA;AAAA,EAEA;AACF;AAIA,IAAM,qBAAA,GAA6C,IAAI,GAAA,CAAY,oBAAoB,CAAA;AAEhF,IAAM,gBAAA,GAAmB,CAAC,GAAA,KAC/B,qBAAA,CAAsB,IAAI,GAAG","file":"sdkAttributes.js","sourcesContent":["/**\n * Reserved SDK attribute keys that the SDK writes automatically during a\n * flow run. They bypass the manifest's `sdkAttributeKeys` allowlist when\n * referenced from decision nodes so authors can branch on provider state\n * without having to declare each key up front.\n */\nexport const RESERVED_RC_SDK_KEYS = [\n  /** Last RC event observed by the SDK (e.g. `purchase_completed`, `purchase_cancelled`). */\n  'onb_rc_last_event',\n  /** Product identifier from the most recent successful purchase. */\n  'onb_rc_last_product_id',\n  /** Period type (`normal`, `intro`, `trial`) from the most recent purchase. */\n  'onb_rc_last_period_type',\n  /** RevenueCat offering id surfaced by the most recent paywall presentation. */\n  'onb_rc_last_offering_id',\n] as const;\n\nexport type ReservedRcSdkKey = (typeof RESERVED_RC_SDK_KEYS)[number];\n\nconst RESERVED_SDK_KEYS_SET: ReadonlySet<string> = new Set<string>(RESERVED_RC_SDK_KEYS);\n\nexport const isReservedSdkKey = (key: string): key is ReservedRcSdkKey =>\n  RESERVED_SDK_KEYS_SET.has(key);\n"]}

package/dist/workspaceCapabilities.d.ts

@@ -0,0 +1,15 @@
+/** Clerk org roles used by Rheo (coarse). */
+declare const CLERK_ORG_ADMIN = "org:admin";
+declare const CLERK_ORG_MEMBER = "org:member";
+declare const WORKSPACE_ROLES: readonly ["owner", "admin", "editor", "viewer"];
+type WorkspaceRole = (typeof WORKSPACE_ROLES)[number];
+declare const WORKSPACE_CAPABILITIES: readonly ["org:read", "billing:manage", "workspace:delete", "workspace:settings", "app:settings", "app:manage", "member:invite", "member:remove", "member:role", "ownership:transfer", "flow:read", "flow:edit", "flow:publish", "channel:read", "channel:manage", "experiment:read", "experiment:manage", "media:manage", "ai:brand_extract", "ai:translate", "store:manage", "analytics:read", "customers:read", "notifications:read", "notifications:write", "apiKey:manage", "rollout:approve"];
+type WorkspaceCapability = (typeof WORKSPACE_CAPABILITIES)[number];
+declare const resolveCapabilities: (role: WorkspaceRole) => ReadonlySet<WorkspaceCapability>;
+declare const hasCapability: (role: WorkspaceRole, capability: WorkspaceCapability) => boolean;
+declare const hasAnyCapability: (role: WorkspaceRole, capabilities: ReadonlyArray<WorkspaceCapability>) => boolean;
+/** Normalize DB / legacy string to WorkspaceRole. */
+declare const parseWorkspaceRole: (raw: string) => WorkspaceRole | null;
+declare const assertWorkspaceRole: (raw: string) => WorkspaceRole;
+
+export { CLERK_ORG_ADMIN, CLERK_ORG_MEMBER, WORKSPACE_CAPABILITIES, WORKSPACE_ROLES, type WorkspaceCapability, type WorkspaceRole, assertWorkspaceRole, hasAnyCapability, hasCapability, parseWorkspaceRole, resolveCapabilities };

package/dist/workspaceCapabilities.js

@@ -0,0 +1,116 @@
+// src/workspaceCapabilities.ts
+var CLERK_ORG_ADMIN = "org:admin";
+var CLERK_ORG_MEMBER = "org:member";
+var WORKSPACE_ROLES = ["owner", "admin", "editor", "viewer"];
+var WORKSPACE_CAPABILITIES = [
+  "org:read",
+  "billing:manage",
+  "workspace:delete",
+  "workspace:settings",
+  "app:settings",
+  "app:manage",
+  "member:invite",
+  "member:remove",
+  "member:role",
+  "ownership:transfer",
+  "flow:read",
+  "flow:edit",
+  "flow:publish",
+  "channel:read",
+  "channel:manage",
+  "experiment:read",
+  "experiment:manage",
+  "media:manage",
+  "ai:brand_extract",
+  "ai:translate",
+  "store:manage",
+  "analytics:read",
+  "customers:read",
+  "notifications:read",
+  "notifications:write",
+  "apiKey:manage",
+  /** Granted at runtime via workspace-access when the member may approve rollouts. */
+  "rollout:approve"
+];
+var OWNER_CAPS = new Set(
+  WORKSPACE_CAPABILITIES.filter((c) => c !== "rollout:approve")
+);
+var caps = (...c) => new Set(c);
+var ROLE_CAPABILITIES = {
+  admin: caps(
+    "org:read",
+    "workspace:settings",
+    "app:settings",
+    "app:manage",
+    "member:invite",
+    "member:remove",
+    "member:role",
+    "flow:read",
+    "flow:edit",
+    "flow:publish",
+    "channel:read",
+    "channel:manage",
+    "experiment:read",
+    "experiment:manage",
+    "media:manage",
+    "ai:brand_extract",
+    "ai:translate",
+    "store:manage",
+    "analytics:read",
+    "customers:read",
+    "notifications:read",
+    "notifications:write"
+  ),
+  editor: caps(
+    "org:read",
+    "flow:read",
+    "flow:edit",
+    "flow:publish",
+    "channel:read",
+    "channel:manage",
+    "experiment:read",
+    "experiment:manage",
+    "media:manage",
+    "ai:brand_extract",
+    "ai:translate",
+    "store:manage",
+    "analytics:read",
+    "customers:read",
+    "notifications:read",
+    "notifications:write"
+  ),
+  viewer: caps(
+    "org:read",
+    "flow:read",
+    "channel:read",
+    "experiment:read",
+    "analytics:read",
+    "customers:read",
+    "notifications:read",
+    "notifications:write"
+  )
+};
+var resolveCapabilities = (role) => {
+  if (role === "owner") return OWNER_CAPS;
+  return ROLE_CAPABILITIES[role];
+};
+var hasCapability = (role, capability) => resolveCapabilities(role).has(capability);
+var hasAnyCapability = (role, capabilities) => {
+  const set = resolveCapabilities(role);
+  return capabilities.some((c) => set.has(c));
+};
+var parseWorkspaceRole = (raw) => {
+  if (raw === "owner" || raw === "admin" || raw === "editor" || raw === "viewer") return raw;
+  return null;
+};
+var assertWorkspaceRole = (raw) => {
+  const r = parseWorkspaceRole(raw);
+  if (!r) {
+    throw new TypeError(`invalid_workspace_role:${raw}`);
+  }
+  return r;
+};
+
+export { CLERK_ORG_ADMIN, CLERK_ORG_MEMBER, WORKSPACE_CAPABILITIES, WORKSPACE_ROLES, assertWorkspaceRole, hasAnyCapability, hasCapability, parseWorkspaceRole, resolveCapabilities };
+//# sourceMappingURL=workspaceCapabilities.js.map
+//# sourceMappingURL=workspaceCapabilities.js.map

package/dist/workspaceCapabilities.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/workspaceCapabilities.ts"],"names":[],"mappings":";AACO,IAAM,eAAA,GAAkB;AACxB,IAAM,gBAAA,GAAmB;AAEzB,IAAM,eAAA,GAAkB,CAAC,OAAA,EAAS,OAAA,EAAS,UAAU,QAAQ;AAG7D,IAAM,sBAAA,GAAyB;AAAA,EACpC,UAAA;AAAA,EACA,gBAAA;AAAA,EACA,kBAAA;AAAA,EACA,oBAAA;AAAA,EACA,cAAA;AAAA,EACA,YAAA;AAAA,EACA,eAAA;AAAA,EACA,eAAA;AAAA,EACA,aAAA;AAAA,EACA,oBAAA;AAAA,EACA,WAAA;AAAA,EACA,WAAA;AAAA,EACA,cAAA;AAAA,EACA,cAAA;AAAA,EACA,gBAAA;AAAA,EACA,iBAAA;AAAA,EACA,mBAAA;AAAA,EACA,cAAA;AAAA,EACA,kBAAA;AAAA,EACA,cAAA;AAAA,EACA,cAAA;AAAA,EACA,gBAAA;AAAA,EACA,gBAAA;AAAA,EACA,oBAAA;AAAA,EACA,qBAAA;AAAA,EACA,eAAA;AAAA;AAAA,EAEA;AACF;AAKA,IAAM,aAAa,IAAI,GAAA;AAAA,EACrB,sBAAA,CAAuB,MAAA,CAAO,CAAC,CAAA,KAAM,MAAM,iBAAiB;AAC9D,CAAA;AAEA,IAAM,IAAA,GAAO,CAAA,GAAI,CAAA,KAA6B,IAAI,IAAI,CAAC,CAAA;AAGvD,IAAM,iBAAA,GAA+F;AAAA,EACnG,KAAA,EAAO,IAAA;AAAA,IACL,UAAA;AAAA,IACA,oBAAA;AAAA,IACA,cAAA;AAAA,IACA,YAAA;AAAA,IACA,eAAA;AAAA,IACA,eAAA;AAAA,IACA,aAAA;AAAA,IACA,WAAA;AAAA,IACA,WAAA;AAAA,IACA,cAAA;AAAA,IACA,cAAA;AAAA,IACA,gBAAA;AAAA,IACA,iBAAA;AAAA,IACA,mBAAA;AAAA,IACA,cAAA;AAAA,IACA,kBAAA;AAAA,IACA,cAAA;AAAA,IACA,cAAA;AAAA,IACA,gBAAA;AAAA,IACA,gBAAA;AAAA,IACA,oBAAA;AAAA,IACA;AAAA,GACF;AAAA,EACA,MAAA,EAAQ,IAAA;AAAA,IACN,UAAA;AAAA,IACA,WAAA;AAAA,IACA,WAAA;AAAA,IACA,cAAA;AAAA,IACA,cAAA;AAAA,IACA,gBAAA;AAAA,IACA,iBAAA;AAAA,IACA,mBAAA;AAAA,IACA,cAAA;AAAA,IACA,kBAAA;AAAA,IACA,cAAA;AAAA,IACA,cAAA;AAAA,IACA,gBAAA;AAAA,IACA,gBAAA;AAAA,IACA,oBAAA;AAAA,IACA;AAAA,GACF;AAAA,EACA,MAAA,EAAQ,IAAA;AAAA,IACN,UAAA;AAAA,IACA,WAAA;AAAA,IACA,cAAA;AAAA,IACA,iBAAA;AAAA,IACA,gBAAA;AAAA,IACA,gBAAA;AAAA,IACA,oBAAA;AAAA,IACA;AAAA;AAEJ,CAAA;AAEO,IAAM,mBAAA,GAAsB,CAAC,IAAA,KAA0D;AAC5F,EAAA,IAAI,IAAA,KAAS,SAAS,OAAO,UAAA;AAC7B,EAAA,OAAO,kBAAkB,IAAI,CAAA;AAC/B;AAEO,IAAM,aAAA,GAAgB,CAC3B,IAAA,EACA,UAAA,KACY,oBAAoB,IAAI,CAAA,CAAE,IAAI,UAAU;AAE/C,IAAM,gBAAA,GAAmB,CAC9B,IAAA,EACA,YAAA,KACY;AACZ,EAAA,MAAM,GAAA,GAAM,oBAAoB,IAAI,CAAA;AACpC,EAAA,OAAO,aAAa,IAAA,CAAK,CAAC,MAAM,GAAA,CAAI,GAAA,CAAI,CAAC,CAAC,CAAA;AAC5C;AAGO,IAAM,kBAAA,GAAqB,CAAC,GAAA,KAAsC;AACvE,EAAA,IAAI,GAAA,KAAQ,WAAW,GAAA,KAAQ,OAAA,IAAW,QAAQ,QAAA,IAAY,GAAA,KAAQ,UAAU,OAAO,GAAA;AACvF,EAAA,OAAO,IAAA;AACT;AAEO,IAAM,mBAAA,GAAsB,CAAC,GAAA,KAA+B;AACjE,EAAA,MAAM,CAAA,GAAI,mBAAmB,GAAG,CAAA;AAChC,EAAA,IAAI,CAAC,CAAA,EAAG;AACN,IAAA,MAAM,IAAI,SAAA,CAAU,CAAA,uBAAA,EAA0B,GAAG,CAAA,CAAE,CAAA;AAAA,EACrD;AACA,EAAA,OAAO,CAAA;AACT","file":"workspaceCapabilities.js","sourcesContent":["/** Clerk org roles used by Rheo (coarse). */\nexport const CLERK_ORG_ADMIN = 'org:admin';\nexport const CLERK_ORG_MEMBER = 'org:member';\n\nexport const WORKSPACE_ROLES = ['owner', 'admin', 'editor', 'viewer'] as const;\nexport type WorkspaceRole = (typeof WORKSPACE_ROLES)[number];\n\nexport const WORKSPACE_CAPABILITIES = [\n  'org:read',\n  'billing:manage',\n  'workspace:delete',\n  'workspace:settings',\n  'app:settings',\n  'app:manage',\n  'member:invite',\n  'member:remove',\n  'member:role',\n  'ownership:transfer',\n  'flow:read',\n  'flow:edit',\n  'flow:publish',\n  'channel:read',\n  'channel:manage',\n  'experiment:read',\n  'experiment:manage',\n  'media:manage',\n  'ai:brand_extract',\n  'ai:translate',\n  'store:manage',\n  'analytics:read',\n  'customers:read',\n  'notifications:read',\n  'notifications:write',\n  'apiKey:manage',\n  /** Granted at runtime via workspace-access when the member may approve rollouts. */\n  'rollout:approve',\n] as const;\n\nexport type WorkspaceCapability = (typeof WORKSPACE_CAPABILITIES)[number];\n\n/** Owner receives all capabilities except `rollout:approve` (that cap is merged per org in workspace-access). */\nconst OWNER_CAPS = new Set<WorkspaceCapability>(\n  WORKSPACE_CAPABILITIES.filter((c) => c !== 'rollout:approve'),\n);\n\nconst caps = (...c: WorkspaceCapability[]) => new Set(c);\n\n/** Role → capabilities (owner is expanded to full set separately). */\nconst ROLE_CAPABILITIES: Record<Exclude<WorkspaceRole, 'owner'>, ReadonlySet<WorkspaceCapability>> = {\n  admin: caps(\n    'org:read',\n    'workspace:settings',\n    'app:settings',\n    'app:manage',\n    'member:invite',\n    'member:remove',\n    'member:role',\n    'flow:read',\n    'flow:edit',\n    'flow:publish',\n    'channel:read',\n    'channel:manage',\n    'experiment:read',\n    'experiment:manage',\n    'media:manage',\n    'ai:brand_extract',\n    'ai:translate',\n    'store:manage',\n    'analytics:read',\n    'customers:read',\n    'notifications:read',\n    'notifications:write',\n  ),\n  editor: caps(\n    'org:read',\n    'flow:read',\n    'flow:edit',\n    'flow:publish',\n    'channel:read',\n    'channel:manage',\n    'experiment:read',\n    'experiment:manage',\n    'media:manage',\n    'ai:brand_extract',\n    'ai:translate',\n    'store:manage',\n    'analytics:read',\n    'customers:read',\n    'notifications:read',\n    'notifications:write',\n  ),\n  viewer: caps(\n    'org:read',\n    'flow:read',\n    'channel:read',\n    'experiment:read',\n    'analytics:read',\n    'customers:read',\n    'notifications:read',\n    'notifications:write',\n  ),\n};\n\nexport const resolveCapabilities = (role: WorkspaceRole): ReadonlySet<WorkspaceCapability> => {\n  if (role === 'owner') return OWNER_CAPS;\n  return ROLE_CAPABILITIES[role];\n};\n\nexport const hasCapability = (\n  role: WorkspaceRole,\n  capability: WorkspaceCapability,\n): boolean => resolveCapabilities(role).has(capability);\n\nexport const hasAnyCapability = (\n  role: WorkspaceRole,\n  capabilities: ReadonlyArray<WorkspaceCapability>,\n): boolean => {\n  const set = resolveCapabilities(role);\n  return capabilities.some((c) => set.has(c));\n};\n\n/** Normalize DB / legacy string to WorkspaceRole. */\nexport const parseWorkspaceRole = (raw: string): WorkspaceRole | null => {\n  if (raw === 'owner' || raw === 'admin' || raw === 'editor' || raw === 'viewer') return raw;\n  return null;\n};\n\nexport const assertWorkspaceRole = (raw: string): WorkspaceRole => {\n  const r = parseWorkspaceRole(raw);\n  if (!r) {\n    throw new TypeError(`invalid_workspace_role:${raw}`);\n  }\n  return r;\n};\n"]}

package/package.json

@@ -0,0 +1,162 @@
+{
+  "name": "@getrheo/contracts",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./animations": {
+      "types": "./dist/animations.d.ts",
+      "import": "./dist/animations.js",
+      "default": "./dist/animations.js"
+    },
+    "./appIntegrations": {
+      "types": "./dist/appIntegrations.d.ts",
+      "import": "./dist/appIntegrations.js",
+      "default": "./dist/appIntegrations.js"
+    },
+    "./canvasEditorGates": {
+      "types": "./dist/canvasEditorGates.d.ts",
+      "import": "./dist/canvasEditorGates.js",
+      "default": "./dist/canvasEditorGates.js"
+    },
+    "./constants": {
+      "types": "./dist/constants/index.d.ts",
+      "import": "./dist/constants/index.js",
+      "default": "./dist/constants/index.js"
+    },
+    "./dashboard": {
+      "types": "./dist/dashboard.d.ts",
+      "import": "./dist/dashboard.js",
+      "default": "./dist/dashboard.js"
+    },
+    "./decisions": {
+      "types": "./dist/decisions.d.ts",
+      "import": "./dist/decisions.js",
+      "default": "./dist/decisions.js"
+    },
+    "./events": {
+      "types": "./dist/events.d.ts",
+      "import": "./dist/events.js",
+      "default": "./dist/events.js"
+    },
+    "./externalSurfaceIntegrations": {
+      "types": "./dist/externalSurfaceIntegrations.d.ts",
+      "import": "./dist/externalSurfaceIntegrations.js",
+      "default": "./dist/externalSurfaceIntegrations.js"
+    },
+    "./externalSurfaces": {
+      "types": "./dist/externalSurfaces.d.ts",
+      "import": "./dist/externalSurfaces.js",
+      "default": "./dist/externalSurfaces.js"
+    },
+    "./fields": {
+      "types": "./dist/fields.d.ts",
+      "import": "./dist/fields.js",
+      "default": "./dist/fields.js"
+    },
+    "./imageContentType": {
+      "types": "./dist/imageContentType.d.ts",
+      "import": "./dist/imageContentType.js",
+      "default": "./dist/imageContentType.js"
+    },
+    "./identity": {
+      "types": "./dist/identity.d.ts",
+      "import": "./dist/identity.js",
+      "default": "./dist/identity.js"
+    },
+    "./layers": {
+      "types": "./dist/layers.d.ts",
+      "import": "./dist/layers.js",
+      "default": "./dist/layers.js"
+    },
+    "./localized": {
+      "types": "./dist/localized.d.ts",
+      "import": "./dist/localized.js",
+      "default": "./dist/localized.js"
+    },
+    "./manifest": {
+      "types": "./dist/manifest.d.ts",
+      "import": "./dist/manifest.js",
+      "default": "./dist/manifest.js"
+    },
+    "./media": {
+      "types": "./dist/media.d.ts",
+      "import": "./dist/media.js",
+      "default": "./dist/media.js"
+    },
+    "./screens": {
+      "types": "./dist/screens.d.ts",
+      "import": "./dist/screens.js",
+      "default": "./dist/screens.js"
+    },
+    "./sdk": {
+      "types": "./dist/sdk.d.ts",
+      "import": "./dist/sdk.js",
+      "default": "./dist/sdk.js"
+    },
+    "./sdkAttributes": {
+      "types": "./dist/sdkAttributes.d.ts",
+      "import": "./dist/sdkAttributes.js",
+      "default": "./dist/sdkAttributes.js"
+    },
+    "./flowTemplates": {
+      "types": "./dist/flowTemplates.d.ts",
+      "import": "./dist/flowTemplates.js",
+      "default": "./dist/flowTemplates.js"
+    },
+    "./flowTemplateComments": {
+      "types": "./dist/flowTemplateComments.d.ts",
+      "import": "./dist/flowTemplateComments.js",
+      "default": "./dist/flowTemplateComments.js"
+    },
+    "./workspaceCapabilities": {
+      "types": "./dist/workspaceCapabilities.d.ts",
+      "import": "./dist/workspaceCapabilities.js",
+      "default": "./dist/workspaceCapabilities.js"
+    },
+    "./planEntitlements": {
+      "types": "./dist/planEntitlements.d.ts",
+      "import": "./dist/planEntitlements.js",
+      "default": "./dist/planEntitlements.js"
+    },
+    "./billingPeriod": {
+      "types": "./dist/billingPeriod.d.ts",
+      "import": "./dist/billingPeriod.js",
+      "default": "./dist/billingPeriod.js"
+    }
+  },
+  "dependencies": {
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.1",
+    "typescript": "^5.6.3",
+    "vitest": "^3.2.6",
+    "@rheo/config": "0.1.0"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/madeinusmate/onboardly.git",
+    "directory": "packages/contracts"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "build": "node ../../scripts/build-publishable-package.mjs"
+  }
+}