@shuffl/api-contracts 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shuffl LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+# Shuffl API contracts
+
+The public [oRPC](https://orpc.dev) contract, endpoint permission catalog and OpenAPI document for the Shuffl API.
+
+Most people want [`@shuffl/sdk`](https://www.npmjs.com/package/@shuffl/sdk), which installs this package and uses it for every method's input and output types. Install it directly only to build your own client or validate against the contract:
+
+```sh
+npm install @shuffl/api-contracts
+```
+
+```ts
+import type { Permission, ShufflContract } from '@shuffl/api-contracts';
+import openapi from '@shuffl/api-contracts/openapi.json' with { type: 'json' };
+```
+
+`@shuffl/api-contracts/schemas` exports the shared Zod validators. The contract, SDK and CLI are released together under one version.
+
+- [Use the SDK and HTTP API](https://shuffl-rebuild.vercel.app/docs/sdk)
+- [Endpoint permissions](https://shuffl-rebuild.vercel.app/docs/api-permissions)

package/dist/base.d.ts

@@ -0,0 +1,77 @@
+import { z } from 'zod';
+export declare const scopes: readonly ['users:read', 'programs:read', 'programs:write', 'runs:write', 'runs:read', 'knowledge:read', 'manager:read', 'users:write', 'participation:write', 'profile:write', 'access:read', 'access:write', 'identities:read', 'identities:write', 'knowledge:manage', 'knowledge:write', 'integrations:read', 'integrations:write', 'hr:read', 'hr:write', 'support:read', 'support:write', 'billing:read', 'billing:write', 'operations:read', 'operations:write', 'operator:read', 'operator:write', 'reports:read', 'workspace:read', 'workspace:write', 'credentials:read', 'credentials:write', 'exports:read', 'assistant:read', 'assistant:write', 'onboarding:read', 'onboarding:write', 'celebrations:read', 'celebrations:write', 'self:read', 'self:write', 'pulse:read', 'pulse:write', 'praise:read', 'praise:write'];
+export declare const scopeSchema: z.ZodEnum<{
+    "access:read": "access:read";
+    "access:write": "access:write";
+    "assistant:read": "assistant:read";
+    "assistant:write": "assistant:write";
+    "billing:read": "billing:read";
+    "billing:write": "billing:write";
+    "celebrations:read": "celebrations:read";
+    "celebrations:write": "celebrations:write";
+    "credentials:read": "credentials:read";
+    "credentials:write": "credentials:write";
+    "exports:read": "exports:read";
+    "hr:read": "hr:read";
+    "hr:write": "hr:write";
+    "identities:read": "identities:read";
+    "identities:write": "identities:write";
+    "integrations:read": "integrations:read";
+    "integrations:write": "integrations:write";
+    "knowledge:manage": "knowledge:manage";
+    "knowledge:read": "knowledge:read";
+    "knowledge:write": "knowledge:write";
+    "manager:read": "manager:read";
+    "onboarding:read": "onboarding:read";
+    "onboarding:write": "onboarding:write";
+    "operations:read": "operations:read";
+    "operations:write": "operations:write";
+    "operator:read": "operator:read";
+    "operator:write": "operator:write";
+    "participation:write": "participation:write";
+    "praise:read": "praise:read";
+    "praise:write": "praise:write";
+    "profile:write": "profile:write";
+    "programs:read": "programs:read";
+    "programs:write": "programs:write";
+    "pulse:read": "pulse:read";
+    "pulse:write": "pulse:write";
+    "reports:read": "reports:read";
+    "runs:read": "runs:read";
+    "runs:write": "runs:write";
+    "self:read": "self:read";
+    "self:write": "self:write";
+    "support:read": "support:read";
+    "support:write": "support:write";
+    "users:read": "users:read";
+    "users:write": "users:write";
+    "workspace:read": "workspace:read";
+    "workspace:write": "workspace:write";
+}>;
+export type Scope = z.infer<typeof scopeSchema>;
+export declare const base: import("@orpc/contract").ContractBuilder<import("@orpc/contract").Schema<unknown, unknown>, import("@orpc/contract").Schema<unknown, unknown>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+    BAD_REQUEST: {
+        message: string;
+    };
+    CONFLICT: {
+        message: string;
+    };
+    FORBIDDEN: {
+        message: string;
+    };
+    NOT_FOUND: {
+        message: string;
+    };
+    PRECONDITION_FAILED: {
+        message: string;
+    };
+    TOO_MANY_REQUESTS: {
+        message: string;
+    };
+    UNAUTHORIZED: {
+        message: string;
+    };
+}>, {
+    scope: Scope | null;
+} & Record<never, never>>;
+export declare const adminScopes: readonly Scope[];

package/dist/base.js

@@ -0,0 +1,92 @@
+import { oc } from '@orpc/contract';
+import { z } from 'zod';
+export const scopes = [
+    'users:read',
+    'programs:read',
+    'programs:write',
+    'runs:write',
+    'runs:read',
+    'knowledge:read',
+    'manager:read',
+    'users:write',
+    'participation:write',
+    'profile:write',
+    'access:read',
+    'access:write',
+    'identities:read',
+    'identities:write',
+    'knowledge:manage',
+    'knowledge:write',
+    'integrations:read',
+    'integrations:write',
+    'hr:read',
+    'hr:write',
+    'support:read',
+    'support:write',
+    'billing:read',
+    'billing:write',
+    'operations:read',
+    'operations:write',
+    'operator:read',
+    'operator:write',
+    'reports:read',
+    'workspace:read',
+    'workspace:write',
+    'credentials:read',
+    'credentials:write',
+    'exports:read',
+    'assistant:read',
+    'assistant:write',
+    'onboarding:read',
+    'onboarding:write',
+    'celebrations:read',
+    'celebrations:write',
+    'self:read',
+    'self:write',
+    'pulse:read',
+    'pulse:write',
+    'praise:read',
+    'praise:write',
+];
+export const scopeSchema = z.enum(scopes);
+export const base = oc.$meta({ scope: null }).errors({
+    BAD_REQUEST: { message: 'Check the request input.' },
+    CONFLICT: { message: 'The resource changed or the request key was reused.' },
+    FORBIDDEN: {
+        message: 'This token or workspace role does not permit the operation.',
+    },
+    NOT_FOUND: { message: 'The requested resource was not found.' },
+    PRECONDITION_FAILED: {
+        message: 'The workspace is not ready for this operation.',
+    },
+    TOO_MANY_REQUESTS: { message: 'Too many requests. Try again shortly.' },
+    UNAUTHORIZED: { message: 'A valid Shuffl API token is required.' },
+});
+export const adminScopes = [
+    'programs:write',
+    'runs:write',
+    'users:write',
+    'access:read',
+    'access:write',
+    'identities:read',
+    'identities:write',
+    'knowledge:manage',
+    'knowledge:write',
+    'integrations:read',
+    'integrations:write',
+    'billing:read',
+    'billing:write',
+    'operations:read',
+    'operations:write',
+    'workspace:write',
+    'workspace:read',
+    'exports:read',
+    'onboarding:read',
+    'onboarding:write',
+    'celebrations:read',
+    'celebrations:write',
+    'pulse:read',
+    'pulse:write',
+    'praise:read',
+    'praise:write',
+];