@shuffl/api-contracts 0.3.0 → 0.5.0

package/dist/base.d.ts

@@ -1,5 +1,5 @@
 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', 'operations:read', 'operations:write', 'operator:read', 'operator:write', 'reports:read', 'team:read', 'team: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 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', 'operations:read', 'operations:write', 'operator:read', 'operator:write', 'reports:read', 'team:read', 'team:write', 'credentials:read', 'credentials:write', 'exports:read', 'assistant:read', 'assistant:write', 'playbooks:read', 'playbooks:write', 'celebrations:read', 'celebrations:write', 'self:read', 'self:write', 'pulse:read', 'pulse:write', 'praise:read', 'praise:write', 'webhooks:read', 'webhooks:write'];
 export declare const scopeSchema: z.ZodEnum<{
     "access:read": "access:read";
     "access:write": "access:write";
@@ -20,13 +20,13 @@ export declare const scopeSchema: z.ZodEnum<{
     "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";
+    "playbooks:read": "playbooks:read";
+    "playbooks:write": "playbooks:write";
     "praise:read": "praise:read";
     "praise:write": "praise:write";
     "profile:write": "profile:write";
@@ -45,6 +45,8 @@ export declare const scopeSchema: z.ZodEnum<{
     "team:write": "team:write";
     "users:read": "users:read";
     "users:write": "users:write";
+    "webhooks:read": "webhooks:read";
+    "webhooks:write": "webhooks: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>, {

package/dist/base.js

@@ -35,8 +35,8 @@ export const scopes = [
     'exports:read',
     'assistant:read',
     'assistant:write',
-    'onboarding:read',
-    'onboarding:write',
+    'playbooks:read',
+    'playbooks:write',
     'celebrations:read',
     'celebrations:write',
     'self:read',
@@ -45,6 +45,8 @@ export const scopes = [
     'pulse:write',
     'praise:read',
     'praise:write',
+    'webhooks:read',
+    'webhooks:write',
 ];
 export const scopeSchema = z.enum(scopes);
 export const base = oc.$meta({ scope: null }).errors({
@@ -77,12 +79,14 @@ export const adminScopes = [
     'team:write',
     'team:read',
     'exports:read',
-    'onboarding:read',
-    'onboarding:write',
+    'playbooks:read',
+    'playbooks:write',
     'celebrations:read',
     'celebrations:write',
     'pulse:read',
     'pulse:write',
     'praise:read',
     'praise:write',
+    'webhooks:read',
+    'webhooks:write',
 ];

package/dist/company.d.ts

@@ -0,0 +1,235 @@
+import { z } from 'zod';
+export declare const companyPermissionCatalog: readonly [{
+    readonly access: 'read';
+    readonly description: 'Read the company name, logo and default workspace';
+    readonly id: 'company.details';
+}, {
+    readonly access: 'read';
+    readonly description: "List the company's workspaces";
+    readonly id: 'company.workspaces.list';
+}, {
+    readonly access: 'read';
+    readonly description: 'List company members and their company roles';
+    readonly id: 'company.members.list';
+}, {
+    readonly access: 'read';
+    readonly description: "List the company's email domains and their verification";
+    readonly id: 'company.emailDomains.list';
+}, {
+    readonly access: 'read';
+    readonly description: 'List the Slack workspaces connected to the company';
+    readonly id: 'company.slack.list';
+}, {
+    readonly access: 'write';
+    readonly description: 'Rename the company';
+    readonly id: 'company.rename';
+}, {
+    readonly access: 'write';
+    readonly description: 'Choose the workspace new email domain and single sign-on members join';
+    readonly id: 'company.workspaces.setDefault';
+}, {
+    readonly access: 'write';
+    readonly description: 'Remove someone from the company (administrators only with an owner’s key)';
+    readonly id: 'company.members.remove';
+}];
+export type CompanyPermission = (typeof companyPermissionCatalog)[number]['id'];
+export type CompanyPermissionDefinition = (typeof companyPermissionCatalog)[number];
+export declare const companyPermissionIds: [CompanyPermission, ...CompanyPermission[]];
+export declare const companyIndexOperation = "company.current";
+export declare const companyKeyPrefix = "shuffl_company_";
+export declare const companyCursorSchema: z.ZodString;
+export declare const companyDetailsSchema: z.ZodObject<{
+    defaultTeamId: z.ZodNullable<z.ZodString>;
+    deleteAfter: z.ZodNullable<z.ZodISODateTime>;
+    deletionRequestedAt: z.ZodNullable<z.ZodISODateTime>;
+    id: z.ZodString;
+    logo: z.ZodNullable<z.ZodString>;
+    name: z.ZodString;
+    role: z.ZodEnum<{
+        admin: "admin";
+        member: "member";
+        owner: "owner";
+    }>;
+}, z.core.$strip>;
+export declare const companyWorkspaceSchema: z.ZodObject<{
+    accessible: z.ZodBoolean;
+    default: z.ZodBoolean;
+    id: z.ZodString;
+    logo: z.ZodNullable<z.ZodString>;
+    member: z.ZodBoolean;
+    name: z.ZodString;
+    status: z.ZodNullable<z.ZodEnum<{
+        active: "active";
+        archived: "archived";
+        paused: "paused";
+        uninstalled: "uninstalled";
+    }>>;
+}, z.core.$strip>;
+export declare const companyMemberSchema: z.ZodObject<{
+    email: z.ZodString;
+    id: z.ZodString;
+    name: z.ZodString;
+    role: z.ZodEnum<{
+        admin: "admin";
+        member: "member";
+        owner: "owner";
+    }>;
+    userId: z.ZodString;
+}, z.core.$strip>;
+export declare const companyEmailDomainSchema: z.ZodObject<{
+    dnsRecord: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>>;
+    domain: z.ZodString;
+    id: z.ZodString;
+    verifiedAt: z.ZodNullable<z.ZodISODateTime>;
+}, z.core.$strip>;
+export declare const companySlackSchema: z.ZodObject<{
+    installation: z.ZodNullable<z.ZodObject<{
+        enterpriseId: z.ZodNullable<z.ZodString>;
+        gridOrganizationId: z.ZodNullable<z.ZodString>;
+        revokedAt: z.ZodNullable<z.ZodISODateTime>;
+        slackTeamId: z.ZodString;
+    }, z.core.$strip>>;
+    teamId: z.ZodString;
+    teamName: z.ZodString;
+}, z.core.$strip>;
+export declare const companyContract: {
+    current: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
+        catalog: z.ZodArray<z.ZodObject<{
+            access: z.ZodEnum<{
+                read: "read";
+                write: "write";
+            }>;
+            description: z.ZodString;
+            granted: z.ZodBoolean;
+            id: z.ZodEnum<{
+                "company.details": "company.details";
+                "company.emailDomains.list": "company.emailDomains.list";
+                "company.members.list": "company.members.list";
+                "company.members.remove": "company.members.remove";
+                "company.rename": "company.rename";
+                "company.slack.list": "company.slack.list";
+                "company.workspaces.list": "company.workspaces.list";
+                "company.workspaces.setDefault": "company.workspaces.setDefault";
+            }>;
+        }, z.core.$strip>>;
+        organizationId: z.ZodString;
+        permissions: z.ZodArray<z.ZodEnum<{
+            "company.details": "company.details";
+            "company.emailDomains.list": "company.emailDomains.list";
+            "company.members.list": "company.members.list";
+            "company.members.remove": "company.members.remove";
+            "company.rename": "company.rename";
+            "company.slack.list": "company.slack.list";
+            "company.workspaces.list": "company.workspaces.list";
+            "company.workspaces.setDefault": "company.workspaces.setDefault";
+        }>>;
+    }, z.core.$strip>, Record<never, never>, {
+        permission: CompanyPermission | null;
+    } & Record<never, never>>;
+    details: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
+        defaultTeamId: z.ZodNullable<z.ZodString>;
+        deleteAfter: z.ZodNullable<z.ZodISODateTime>;
+        deletionRequestedAt: z.ZodNullable<z.ZodISODateTime>;
+        id: z.ZodString;
+        logo: z.ZodNullable<z.ZodString>;
+        name: z.ZodString;
+        role: z.ZodEnum<{
+            admin: "admin";
+            member: "member";
+            owner: "owner";
+        }>;
+    }, z.core.$strip>, Record<never, never>, {
+        permission: CompanyPermission | null;
+    } & Record<never, never>>;
+    emailDomains: {
+        list: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodArray<z.ZodObject<{
+            dnsRecord: z.ZodNullable<z.ZodObject<{
+                name: z.ZodString;
+                value: z.ZodString;
+            }, z.core.$strip>>;
+            domain: z.ZodString;
+            id: z.ZodString;
+            verifiedAt: z.ZodNullable<z.ZodISODateTime>;
+        }, z.core.$strip>>, Record<never, never>, {
+            permission: CompanyPermission | null;
+        } & Record<never, never>>;
+    };
+    members: {
+        list: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+            cursor: z.ZodOptional<z.ZodString>;
+            limit: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$strip>, z.ZodObject<{
+            items: z.ZodArray<z.ZodObject<{
+                email: z.ZodString;
+                id: z.ZodString;
+                name: z.ZodString;
+                role: z.ZodEnum<{
+                    admin: "admin";
+                    member: "member";
+                    owner: "owner";
+                }>;
+                userId: z.ZodString;
+            }, z.core.$strip>>;
+            nextCursor: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>, Record<never, never>, {
+            permission: CompanyPermission | null;
+        } & Record<never, never>>;
+        remove: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+            userId: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            removed: z.ZodBoolean;
+        }, z.core.$strip>, Record<never, never>, {
+            permission: CompanyPermission | null;
+        } & Record<never, never>>;
+    };
+    rename: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        name: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        name: z.ZodString;
+    }, z.core.$strip>, Record<never, never>, {
+        permission: CompanyPermission | null;
+    } & Record<never, never>>;
+    slack: {
+        list: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodArray<z.ZodObject<{
+            installation: z.ZodNullable<z.ZodObject<{
+                enterpriseId: z.ZodNullable<z.ZodString>;
+                gridOrganizationId: z.ZodNullable<z.ZodString>;
+                revokedAt: z.ZodNullable<z.ZodISODateTime>;
+                slackTeamId: z.ZodString;
+            }, z.core.$strip>>;
+            teamId: z.ZodString;
+            teamName: z.ZodString;
+        }, z.core.$strip>>, Record<never, never>, {
+            permission: CompanyPermission | null;
+        } & Record<never, never>>;
+    };
+    workspaces: {
+        list: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodArray<z.ZodObject<{
+            accessible: z.ZodBoolean;
+            default: z.ZodBoolean;
+            id: z.ZodString;
+            logo: z.ZodNullable<z.ZodString>;
+            member: z.ZodBoolean;
+            name: z.ZodString;
+            status: z.ZodNullable<z.ZodEnum<{
+                active: "active";
+                archived: "archived";
+                paused: "paused";
+                uninstalled: "uninstalled";
+            }>>;
+        }, z.core.$strip>>, Record<never, never>, {
+            permission: CompanyPermission | null;
+        } & Record<never, never>>;
+        setDefault: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+            teamId: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            teamId: z.ZodString;
+        }, z.core.$strip>, Record<never, never>, {
+            permission: CompanyPermission | null;
+        } & Record<never, never>>;
+    };
+};
+export type ShufflCompanyContract = typeof companyContract;

package/dist/company.js

@@ -0,0 +1,177 @@
+import { oc } from '@orpc/contract';
+import { z } from 'zod';
+// #1192, #1692: the company API. A company key (shuffl_company_) manages one
+// company's settings and never reaches a workspace; a workspace key never
+// reaches this API. Its operations are served under /api/v1/company, outside
+// the workspace contract and its permission catalog, so a workspace key can
+// never be granted one. OpenAPI, the SDK's createShufflCompany client, the CLI's
+// `shuffl company` commands and the REST reference are all generated from this
+// file. A permission is one company settings action, run as the key's issuer
+// with that person's current company role.
+//
+// Kept in the browser on purpose, for every credential: deleting or restoring
+// the company, transferring ownership, changing company roles, email domains,
+// single sign-on, SCIM, Slack Grid mapping, billing and product analytics. A
+// key never adds access, so nothing here can widen who reaches the company.
+export const companyPermissionCatalog = [
+    {
+        access: 'read',
+        description: 'Read the company name, logo and default workspace',
+        id: 'company.details',
+    },
+    {
+        access: 'read',
+        description: "List the company's workspaces",
+        id: 'company.workspaces.list',
+    },
+    {
+        access: 'read',
+        description: 'List company members and their company roles',
+        id: 'company.members.list',
+    },
+    {
+        access: 'read',
+        description: "List the company's email domains and their verification",
+        id: 'company.emailDomains.list',
+    },
+    {
+        access: 'read',
+        description: 'List the Slack workspaces connected to the company',
+        id: 'company.slack.list',
+    },
+    {
+        access: 'write',
+        description: 'Rename the company',
+        id: 'company.rename',
+    },
+    {
+        access: 'write',
+        description: 'Choose the workspace new email domain and single sign-on members join',
+        id: 'company.workspaces.setDefault',
+    },
+    {
+        access: 'write',
+        description: 'Remove someone from the company (administrators only with an owner’s key)',
+        id: 'company.members.remove',
+    },
+];
+export const companyPermissionIds = companyPermissionCatalog.map((permission) => permission.id);
+// Readable by every valid company key, like teams.current for a workspace key.
+export const companyIndexOperation = 'company.current';
+export const companyKeyPrefix = 'shuffl_company_';
+const companyBase = oc.$meta({
+    permission: null,
+});
+const read = (permission, path) => companyBase.meta({ permission }).route({ method: 'GET', path });
+const write = (permission, path) => companyBase.meta({ permission }).route({ method: 'POST', path });
+const id = z.string().min(1).max(128);
+const time = z.iso.datetime();
+const companyRole = z.enum(['owner', 'admin', 'member']);
+export const companyCursorSchema = z.string().min(1).max(1024);
+export const companyDetailsSchema = z.object({
+    defaultTeamId: id
+        .nullable()
+        .describe('The workspace new email domain and single sign-on members join.'),
+    deleteAfter: time
+        .nullable()
+        .describe('When a deleted company is erased, or null.'),
+    deletionRequestedAt: time
+        .nullable()
+        .describe('When someone deleted the company, or null.'),
+    id,
+    logo: z.string().nullable(),
+    name: z.string(),
+    role: companyRole.describe('The company role of the person who made the key.'),
+});
+export const companyWorkspaceSchema = z.object({
+    accessible: z
+        .boolean()
+        .describe('Whether the person who made the key can open the workspace.'),
+    default: z.boolean().describe('Whether this is the default workspace.'),
+    id,
+    logo: z.string().nullable(),
+    member: z
+        .boolean()
+        .describe('Whether the person who made the key is a member of it.'),
+    name: z.string(),
+    status: z.enum(['active', 'paused', 'uninstalled', 'archived']).nullable(),
+});
+export const companyMemberSchema = z.object({
+    email: z.string(),
+    id: id.describe('The company membership id.'),
+    name: z.string(),
+    role: companyRole,
+    userId: id.describe('The person’s user id. members.remove takes this.'),
+});
+export const companyEmailDomainSchema = z.object({
+    dnsRecord: z
+        .object({ name: z.string(), value: z.string() })
+        .nullable()
+        .describe('The TXT record that proves the domain, until it is verified.'),
+    domain: z.string(),
+    id,
+    verifiedAt: time.nullable(),
+});
+export const companySlackSchema = z.object({
+    installation: z
+        .object({
+        enterpriseId: z.string().nullable(),
+        gridOrganizationId: z.string().nullable(),
+        revokedAt: time
+            .nullable()
+            .describe('When the connection stopped working, or null.'),
+        slackTeamId: z.string(),
+    })
+        .nullable()
+        .describe('The Slack connection, or null when the workspace has none.'),
+    teamId: id,
+    teamName: z.string(),
+});
+export const companyContract = {
+    current: read(null, '/company')
+        .route({
+        summary: 'Read the company this key belongs to and the permissions it was granted',
+    })
+        .output(z.object({
+        catalog: z.array(z.object({
+            access: z.enum(['read', 'write']),
+            description: z.string(),
+            granted: z.boolean(),
+            id: z.enum(companyPermissionIds),
+        })),
+        organizationId: id,
+        permissions: z.array(z.enum(companyPermissionIds)),
+    })),
+    details: read('company.details', '/company/details').output(companyDetailsSchema),
+    emailDomains: {
+        list: read('company.emailDomains.list', '/company/emailDomains.list').output(z.array(companyEmailDomainSchema)),
+    },
+    members: {
+        list: read('company.members.list', '/company/members.list')
+            .input(z.object({
+            cursor: companyCursorSchema
+                .optional()
+                .describe('nextCursor from the previous page.'),
+            limit: z.number().int().min(1).max(100).default(25),
+        }))
+            .output(z.object({
+            items: z.array(companyMemberSchema),
+            nextCursor: companyCursorSchema.nullable(),
+        })),
+        remove: write('company.members.remove', '/company/members.remove')
+            .input(z.object({ userId: id }))
+            .output(z.object({ removed: z.boolean() })),
+    },
+    rename: write('company.rename', '/company/rename')
+        .input(z.object({ name: z.string().trim().min(1).max(100) }))
+        .output(z.object({ name: z.string() })),
+    slack: {
+        list: read('company.slack.list', '/company/slack.list').output(z.array(companySlackSchema)),
+    },
+    workspaces: {
+        list: read('company.workspaces.list', '/company/workspaces.list').output(z.array(companyWorkspaceSchema)),
+        setDefault: write('company.workspaces.setDefault', '/company/workspaces.setDefault')
+            .input(z.object({ teamId: id }))
+            .output(z.object({ teamId: id })),
+    },
+};