@timbenniks/contentstack-platform-sdk 0.1.4 → 0.1.7

package/dist/index.cjs

@@ -42,6 +42,8 @@ __export(index_exports, {
   GlobalFieldsClient: () => GlobalFieldsClient,
   LabelsClient: () => LabelsClient,
   LocalesClient: () => LocalesClient,
+  OAUTH_SCOPE_DESCRIPTIONS: () => OAUTH_SCOPE_DESCRIPTIONS,
+  OAUTH_SCOPE_PRESETS: () => OAUTH_SCOPE_PRESETS,
   PublishRulesClient: () => PublishRulesClient,
   ReleasesClient: () => ReleasesClient,
   RolesClient: () => RolesClient,
@@ -276,6 +278,181 @@ async function parseErrorResponse(response, path) {
   }
 }
 
+// src/auth/scopes.ts
+var OAUTH_SCOPE_DESCRIPTIONS = {
+  // User
+  "user:read": "View user details",
+  "user:write": "Update user details",
+  "user.assignments:read": "View user assignments",
+  // Organization
+  "organizations:read": "View details of all organizations associated with the user",
+  "organization:read": "View details of an organization",
+  "organization.logs:read": "View organization logs",
+  "organization.ownership:write": "Transfer organization ownership",
+  "organization.roles:read": "View organization-level roles",
+  "organization.share:write": "Update or remove organization invitation shares",
+  "organization.share:read": "View details of organization invitations shared with users",
+  // Stack management
+  "cm.stacks.management:read": "View all stacks",
+  "cm.stacks.management:write": "Create, update, or remove stacks",
+  "cm.stack.users:read": "View users associated with a stack",
+  "cm.stack.users:write": "Update user roles and user associations",
+  "cm.stack.management:write": "Update stack management properties",
+  "cm.stack.settings:read": "View stack settings",
+  "cm.stack:share": "Share stack invitation with users",
+  "cm.stack:unshare": "Unshare stack invitations",
+  // Tokens
+  "cm.stack.delivery-tokens:read": "View delivery tokens associated with a stack",
+  "cm.stack.delivery-tokens:write": "Create, update, or remove delivery tokens",
+  "cm.stack.management-tokens:read": "View management tokens associated with a stack",
+  "cm.stack.management-tokens:write": "Create, update, or remove management tokens",
+  // Content types
+  "cm.content-types.management:read": "View all content types",
+  "cm.content-types.management:write": "Create, update, or remove content types",
+  "cm.content-type:read": "View content type details",
+  "cm.content-types:export": "Export content types",
+  "cm.content-types:import": "Import content types",
+  // Global fields
+  "cm.global-fields.management:read": "View all global fields",
+  "cm.global-fields.management:write": "Create, update, or remove global fields",
+  "cm.global-fields:import": "Import global fields",
+  // Entries
+  "cm.entries.management:read": "View all entries",
+  "cm.entries.management:write": "Create, update, or remove entries",
+  "cm.entry:write": "Update details associated with an entry",
+  "cm.entry:read": "View details associated with an entry",
+  "cm.entries:export": "Export entries",
+  "cm.entries:import": "Import entries",
+  "cm.entry:publish": "Publish an entry",
+  "cm.entry:unpublish": "Unpublish an entry",
+  "cm.entry.workflow:write": "Set workflow stage for an entry",
+  // Bulk operations
+  "cm.bulk-operations:publish": "Publish items in bulk",
+  "cm.bulk-operations:unpublish": "Unpublish items in bulk",
+  "cm.bulk-operations:delete": "Delete items in bulk",
+  "cm.bulk-operations:workflow": "Set workflow stage in bulk",
+  // Assets
+  "cm.assets.management:read": "View all assets",
+  "cm.assets.management:write": "Create, update, or remove assets",
+  "cm.assets:download": "Download assets",
+  "cm.assets.rt:read": "View all RTE assets",
+  "cm.asset:write": "Create, update, or remove an asset",
+  "cm.asset:read": "View asset details",
+  "cm.asset:publish": "Publish an asset",
+  "cm.asset:unpublish": "Unpublish an asset",
+  // Extensions
+  "cm.extensions.management:read": "View all extensions",
+  "cm.extensions.management:write": "Create, update, or remove extensions",
+  // Releases
+  "cm.releases.management:read": "View all releases",
+  "cm.releases.management:write": "Create, update, or remove releases",
+  "cm.release:read": "View details associated with a release",
+  "cm.release:write": "Update details associated with a release",
+  "cm.release:deploy": "Deploy a release",
+  "cm.release:clone": "Clone a release",
+  // Workflows
+  "cm.workflows.management:read": "View all workflows",
+  "cm.workflows.management:write": "Create, update, or remove workflows",
+  "cm.workflows.publishing-rules:write": "Create, update, or remove workflow publishing rules",
+  "cm.workflows.publishing-rules:read": "View all workflow publishing rules",
+  // Labels
+  "cm.labels.management:read": "View all labels",
+  "cm.labels.management:write": "Create, update, or remove labels",
+  // Languages
+  "cm.languages.management:read": "View all languages",
+  "cm.languages.management:write": "Create, update, or remove languages",
+  // Environments
+  "cm.environments.management:read": "View all environments",
+  "cm.environments.management:write": "Create, update, or remove environments",
+  // Roles
+  "cm.roles.management:read": "View all roles",
+  "cm.roles.management:write": "Create, update, or remove roles",
+  // Webhooks
+  "cm.webhooks.management:read": "View all webhooks",
+  "cm.webhooks.management:write": "Create, update, or remove webhooks",
+  "cm.webhooks:export": "Export webhooks",
+  "cm.webhooks:import": "Import webhooks",
+  "cm.webhook:read": "View webhook details",
+  // Audit & publish queue
+  "cm.audit-logs:read": "View all audit logs",
+  "cm.publish-queue.management:read": "View all publish queue items",
+  "cm.publish-queue.management:write": "Create, update, or remove publish queue items",
+  // Branches
+  "cm.branches.management:read": "View all branches",
+  "cm.branches.management:write": "Create or delete a branch",
+  "cm.branch-aliases.management:read": "View all branch aliases",
+  "cm.branch-aliases.management:write": "Create, assign, or delete a branch alias",
+  // Taxonomies
+  "cm.taxonomies.management:read": "View all taxonomies",
+  "cm.taxonomies.management:write": "Create, update, or delete taxonomies",
+  "cm.taxonomy.terms:read": "View all terms of a taxonomy",
+  "cm.taxonomy.terms:write": "Create, update, move, or delete taxonomy terms",
+  // Brand Kit
+  "brand-kits:read": "View Brand Kits and Voice Profiles; use generative AI content generation",
+  "brand-kits:manage": "Create, update, or delete Brand Kits, Voice Profiles, and Knowledge Vault items",
+  // Personalization
+  "personalize:read": "View attributes, audiences, events, experiences, analytics, and regional data",
+  "personalize:manage": "Create, update, or delete personalization components",
+  // Launch
+  "launch:manage": "Read, update, and manage all Launch resources",
+  "launch.projects:read": "Read Launch projects and deployments",
+  "launch.projects:write": "Create and update Launch projects and deployments",
+  "launch.projects:delete": "Delete Launch projects"
+};
+var OAUTH_SCOPE_PRESETS = {
+  /** Minimal: only read the authenticated user's profile. */
+  readOnly: ["user:read"],
+  /** Read content types, entries, and assets. */
+  contentReader: [
+    "user:read",
+    "cm.content-types.management:read",
+    "cm.entries.management:read",
+    "cm.assets.management:read"
+  ],
+  /** Read and write entries and assets; read content types. */
+  cmsAuthoring: [
+    "user:read",
+    "cm.content-types.management:read",
+    "cm.entries.management:read",
+    "cm.entries.management:write",
+    "cm.entry:publish",
+    "cm.entry:unpublish",
+    "cm.assets.management:read",
+    "cm.assets.management:write",
+    "cm.asset:publish",
+    "cm.asset:unpublish"
+  ],
+  /** CMS authoring plus taxonomy management. */
+  cmsAuthoringWithTaxonomies: [
+    "user:read",
+    "cm.content-types.management:read",
+    "cm.entries.management:read",
+    "cm.entries.management:write",
+    "cm.entry:publish",
+    "cm.entry:unpublish",
+    "cm.assets.management:read",
+    "cm.assets.management:write",
+    "cm.asset:publish",
+    "cm.asset:unpublish",
+    "cm.taxonomies.management:read",
+    "cm.taxonomies.management:write",
+    "cm.taxonomy.terms:read",
+    "cm.taxonomy.terms:write"
+  ],
+  /** Brand Kit: read and manage voice profiles and knowledge vault. */
+  brandKit: ["user:read", "brand-kits:read", "brand-kits:manage"],
+  /** Launch: manage projects and deployments. */
+  launch: [
+    "user:read",
+    "launch:manage",
+    "launch.projects:read",
+    "launch.projects:write",
+    "launch.projects:delete"
+  ],
+  /** Personalization: read and manage experiences. */
+  personalization: ["user:read", "personalize:read", "personalize:manage"]
+};
+
 // src/http/client.ts
 var DEFAULT_TIMEOUT = 3e4;
 var DEFAULT_RETRY_LIMIT = 5;
@@ -2865,6 +3042,8 @@ function createGenerativeAIClient(config) {
   GlobalFieldsClient,
   LabelsClient,
   LocalesClient,
+  OAUTH_SCOPE_DESCRIPTIONS,
+  OAUTH_SCOPE_PRESETS,
   PublishRulesClient,
   ReleasesClient,
   RolesClient,