@shipstatic/types 2.0.0 → 2.1.0

package/dist/index.d.ts

@@ -555,10 +555,30 @@ export declare const AuthMethod: {
     readonly SESSION: "session";
     readonly API_KEY: "apiKey";
     readonly TOKEN: "token";
+    readonly OAUTH: "oauth";
     readonly WEBHOOK: "webhook";
     readonly SYSTEM: "system";
 };
 export type AuthMethodType = typeof AuthMethod[keyof typeof AuthMethod];
+/**
+ * OAuth scope vocabulary for delegated third-party access tokens.
+ * Single source of truth used by the authorization server (advertised in
+ * `scopes_supported`), the API's scope-enforcement middleware, and consent UI
+ * copy. The standard `offline_access` scope (refresh tokens) is not platform
+ * vocabulary and is deliberately absent — the middleware never checks it.
+ *
+ * Deliberately absent by design: any `tokens:*` scope, `account:write`, or
+ * admin scope — a delegated app must never mint credentials, delete the
+ * account, or act as admin.
+ */
+export declare const OAuthScope: {
+    readonly ACCOUNT_READ: "account:read";
+    readonly DEPLOYMENTS_READ: "deployments:read";
+    readonly DEPLOYMENTS_WRITE: "deployments:write";
+    readonly DOMAINS_READ: "domains:read";
+    readonly DOMAINS_WRITE: "domains:write";
+};
+export type OAuthScopeType = typeof OAuthScope[keyof typeof OAuthScope];
 export declare const DEPLOYMENT_CONFIG_FILENAME = "ship.json";
 /** Default ship.json config for SPA routing. Single source of truth — used by both API and SDK. */
 export declare const SPA_DEFAULT_CONFIG: {

package/dist/index.js

@@ -448,9 +448,28 @@ export const AuthMethod = {
     SESSION: 'session',
     API_KEY: 'apiKey',
     TOKEN: 'token',
+    OAUTH: 'oauth',
     WEBHOOK: 'webhook',
     SYSTEM: 'system'
 };
+/**
+ * OAuth scope vocabulary for delegated third-party access tokens.
+ * Single source of truth used by the authorization server (advertised in
+ * `scopes_supported`), the API's scope-enforcement middleware, and consent UI
+ * copy. The standard `offline_access` scope (refresh tokens) is not platform
+ * vocabulary and is deliberately absent — the middleware never checks it.
+ *
+ * Deliberately absent by design: any `tokens:*` scope, `account:write`, or
+ * admin scope — a delegated app must never mint credentials, delete the
+ * account, or act as admin.
+ */
+export const OAuthScope = {
+    ACCOUNT_READ: 'account:read',
+    DEPLOYMENTS_READ: 'deployments:read',
+    DEPLOYMENTS_WRITE: 'deployments:write',
+    DOMAINS_READ: 'domains:read',
+    DOMAINS_WRITE: 'domains:write',
+};
 // Deployment Configuration
 export const DEPLOYMENT_CONFIG_FILENAME = 'ship.json';
 /** Default ship.json config for SPA routing. Single source of truth — used by both API and SDK. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipstatic/types",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Shared types for ShipStatic platform",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -840,12 +840,34 @@ export const AuthMethod = {
   SESSION: 'session',
   API_KEY: 'apiKey',
   TOKEN: 'token',
+  OAUTH: 'oauth',
   WEBHOOK: 'webhook',
   SYSTEM: 'system'
 } as const;
 
 export type AuthMethodType = typeof AuthMethod[keyof typeof AuthMethod];
 
+/**
+ * OAuth scope vocabulary for delegated third-party access tokens.
+ * Single source of truth used by the authorization server (advertised in
+ * `scopes_supported`), the API's scope-enforcement middleware, and consent UI
+ * copy. The standard `offline_access` scope (refresh tokens) is not platform
+ * vocabulary and is deliberately absent — the middleware never checks it.
+ *
+ * Deliberately absent by design: any `tokens:*` scope, `account:write`, or
+ * admin scope — a delegated app must never mint credentials, delete the
+ * account, or act as admin.
+ */
+export const OAuthScope = {
+  ACCOUNT_READ: 'account:read',
+  DEPLOYMENTS_READ: 'deployments:read',
+  DEPLOYMENTS_WRITE: 'deployments:write',
+  DOMAINS_READ: 'domains:read',
+  DOMAINS_WRITE: 'domains:write',
+} as const;
+
+export type OAuthScopeType = typeof OAuthScope[keyof typeof OAuthScope];
+
 // Deployment Configuration
 export const DEPLOYMENT_CONFIG_FILENAME = 'ship.json';