@sylphx/contract 0.2.0

package/dist/endpoints/plans.js

@@ -0,0 +1,83 @@
+/**
+ * Plans endpoints — developer-facing subscription plan CRUD for the Console.
+ * Mirrors `apps/api/src/server/platform/routes/plans.ts`.
+ *
+ * Production mount: `/plans`. List / get are nested under `/projects/:id/*`
+ * (to keep the path shape discoverable); create / update / delete / sync /
+ * reorder live at `/plans/*` with the project slug passed in the body so the
+ * handler can look it up via org membership.
+ *
+ * Distinct from `adminPlansEndpoints` (super-admin cross-org) and from
+ * `billingConsoleEndpoints.listPlans` (read-only catalog for subscription
+ * checkout, keyed by query `projectId`).
+ */
+import { defineEndpoint } from '../endpoint.js';
+import { CreatePlanInput, CreatePlanResult, DeletePlanInput, DeletePlanResult, GetPlanResult, ListPlansResult, PlanIdParams, PlansProjectPath, ProjectAndPlanIdParams, ReorderPlansInput, ReorderPlansResult, SyncStripeInput, SyncStripeResult, UpdatePlanInput, UpdatePlanResult, } from '../schemas/plans.js';
+export const plansEndpoints = {
+    list: defineEndpoint({
+        method: 'GET',
+        path: '/plans/projects/:id/plans',
+        params: PlansProjectPath,
+        response: ListPlansResult,
+        plane: 'management',
+        summary: 'List all subscription plans for a project',
+        tags: ['plans'],
+    }),
+    get: defineEndpoint({
+        method: 'GET',
+        path: '/plans/projects/:id/plans/:planId',
+        params: ProjectAndPlanIdParams,
+        response: GetPlanResult,
+        plane: 'management',
+        summary: 'Get subscription plan detail (includes Stripe price IDs)',
+        tags: ['plans'],
+    }),
+    create: defineEndpoint({
+        method: 'POST',
+        path: '/plans/plans',
+        body: CreatePlanInput,
+        response: CreatePlanResult,
+        plane: 'management',
+        summary: 'Create a subscription plan with automatic Stripe price creation',
+        tags: ['plans'],
+    }),
+    update: defineEndpoint({
+        method: 'PATCH',
+        path: '/plans/plans/:planId',
+        params: PlanIdParams,
+        body: UpdatePlanInput,
+        response: UpdatePlanResult,
+        plane: 'management',
+        summary: 'Update a subscription plan; price changes create new Stripe prices',
+        tags: ['plans'],
+    }),
+    delete: defineEndpoint({
+        method: 'DELETE',
+        path: '/plans/plans/:planId',
+        params: PlanIdParams,
+        body: DeletePlanInput,
+        response: DeletePlanResult,
+        plane: 'management',
+        summary: 'Soft-delete a subscription plan (blocked if active subscriptions exist)',
+        tags: ['plans'],
+    }),
+    syncStripe: defineEndpoint({
+        method: 'POST',
+        path: '/plans/plans/:planId/sync-stripe',
+        params: PlanIdParams,
+        body: SyncStripeInput,
+        response: SyncStripeResult,
+        plane: 'management',
+        summary: 'Create Stripe prices for plans that are missing them',
+        tags: ['plans'],
+    }),
+    reorder: defineEndpoint({
+        method: 'POST',
+        path: '/plans/plans/reorder',
+        body: ReorderPlansInput,
+        response: ReorderPlansResult,
+        plane: 'management',
+        summary: 'Update the display order of plans',
+        tags: ['plans'],
+    }),
+};

package/dist/endpoints/privacy.d.ts

@@ -0,0 +1,131 @@
+/**
+ * Privacy endpoints — Console-plane cookie scanning + consent-type linking.
+ * Mirrors `apps/api/src/server/platform/routes/privacy.ts`.
+ *
+ * Production mount: `/privacy/*`.
+ */
+import { Schema } from 'effect';
+export declare const privacyEndpoints: {
+    readonly startScan: import("../endpoint.js").Endpoint<"POST", "/privacy/scans", Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        projectId: typeof Schema.String;
+        url: typeof Schema.String;
+        maxPages: Schema.optional<typeof Schema.Number>;
+        includeSubdomains: Schema.optional<typeof Schema.Boolean>;
+    }>, Schema.Struct<{
+        scanId: typeof Schema.String;
+        status: Schema.Literal<["pending", "running", "completed", "failed"]>;
+        message: typeof Schema.String;
+    }>>;
+    readonly getScan: import("../endpoint.js").Endpoint<"GET", "/privacy/projects/:id/scans/:scanId", Schema.Struct<{
+        id: typeof Schema.String;
+        scanId: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        id: typeof Schema.String;
+        url: typeof Schema.String;
+        status: Schema.Literal<["pending", "running", "completed", "failed"]>;
+        pagesCrawled: Schema.NullOr<typeof Schema.Number>;
+        totalCookies: Schema.NullOr<typeof Schema.Number>;
+        firstPartyCookies: Schema.NullOr<typeof Schema.Number>;
+        thirdPartyCookies: Schema.NullOr<typeof Schema.Number>;
+        categoryCounts: Schema.NullOr<Schema.Record$<typeof Schema.String, typeof Schema.Number>>;
+        error: Schema.NullOr<typeof Schema.String>;
+        startedAt: Schema.NullOr<typeof Schema.String>;
+        completedAt: Schema.NullOr<typeof Schema.String>;
+        durationMs: Schema.NullOr<typeof Schema.Number>;
+        createdAt: typeof Schema.String;
+    }>>;
+    readonly listScans: import("../endpoint.js").Endpoint<"GET", "/privacy/projects/:id/scans", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Struct<{
+        status: Schema.optional<Schema.Literal<["pending", "running", "completed", "failed"]>>;
+        limit: Schema.optional<typeof Schema.String>;
+        offset: Schema.optional<typeof Schema.String>;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        scans: Schema.Array$<Schema.Struct<{
+            id: typeof Schema.String;
+            url: typeof Schema.String;
+            status: Schema.Literal<["pending", "running", "completed", "failed"]>;
+            totalCookies: Schema.NullOr<typeof Schema.Number>;
+            completedAt: Schema.NullOr<typeof Schema.String>;
+            createdAt: typeof Schema.String;
+        }>>;
+        total: typeof Schema.Number;
+        limit: typeof Schema.Number;
+        offset: typeof Schema.Number;
+    }>>;
+    readonly listCookies: import("../endpoint.js").Endpoint<"GET", "/privacy/projects/:id/cookies", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Struct<{
+        scanId: Schema.optional<typeof Schema.String>;
+        category: Schema.optional<Schema.Literal<["necessary", "analytics", "marketing", "preferences", "functional", "unknown"]>>;
+        party: Schema.optional<Schema.Literal<["first_party", "third_party"]>>;
+        search: Schema.optional<typeof Schema.String>;
+        limit: Schema.optional<typeof Schema.String>;
+        offset: Schema.optional<typeof Schema.String>;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        cookies: Schema.Array$<Schema.Struct<{
+            id: typeof Schema.String;
+            name: typeof Schema.String;
+            domain: typeof Schema.String;
+            path: Schema.NullOr<typeof Schema.String>;
+            party: Schema.Literal<["first_party", "third_party"]>;
+            category: Schema.Literal<["necessary", "analytics", "marketing", "preferences", "functional", "unknown"]>;
+            expirationSeconds: Schema.NullOr<typeof Schema.Number>;
+            isSession: typeof Schema.Boolean;
+            isSecure: typeof Schema.Boolean;
+            isHttpOnly: typeof Schema.Boolean;
+            sameSite: Schema.NullOr<typeof Schema.String>;
+            provider: Schema.NullOr<typeof Schema.String>;
+            description: Schema.NullOr<typeof Schema.String>;
+            consentTypeId: Schema.NullOr<typeof Schema.String>;
+            createdAt: typeof Schema.String;
+        }>>;
+        total: typeof Schema.Number;
+        limit: typeof Schema.Number;
+        offset: typeof Schema.Number;
+    }>>;
+    readonly getSummary: import("../endpoint.js").Endpoint<"GET", "/privacy/projects/:id/summary", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        totalScans: typeof Schema.Number;
+        lastScanAt: Schema.NullOr<typeof Schema.String>;
+        totalCookiesDetected: typeof Schema.Number;
+        byCategoryCount: Schema.Record$<typeof Schema.String, typeof Schema.Number>;
+        byPartyCount: Schema.Record$<typeof Schema.String, typeof Schema.Number>;
+        unmappedCookies: typeof Schema.Number;
+    }>>;
+    readonly updateCookieCategory: import("../endpoint.js").Endpoint<"PATCH", "/privacy/projects/:id/cookies/:cookieId/category", Schema.Struct<{
+        id: typeof Schema.String;
+        cookieId: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        category: Schema.Literal<["necessary", "analytics", "marketing", "preferences", "functional", "unknown"]>;
+    }>, Schema.Struct<{
+        id: typeof Schema.String;
+        name: typeof Schema.String;
+        category: Schema.Literal<["necessary", "analytics", "marketing", "preferences", "functional", "unknown"]>;
+    }>>;
+    readonly linkCookie: import("../endpoint.js").Endpoint<"PATCH", "/privacy/projects/:id/cookies/:cookieId/consent-type", Schema.Struct<{
+        id: typeof Schema.String;
+        cookieId: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        consentTypeId: Schema.NullOr<typeof Schema.String>;
+    }>, Schema.Struct<{
+        id: typeof Schema.String;
+        name: typeof Schema.String;
+        consentTypeId: Schema.NullOr<typeof Schema.String>;
+    }>>;
+    readonly bulkLinkCookies: import("../endpoint.js").Endpoint<"POST", "/privacy/cookies/bulk-link", Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        projectId: typeof Schema.String;
+        category: Schema.Literal<["necessary", "analytics", "marketing", "preferences", "functional", "unknown"]>;
+        consentTypeId: typeof Schema.String;
+    }>, Schema.Struct<{
+        linkedCount: typeof Schema.Number;
+        category: Schema.Literal<["necessary", "analytics", "marketing", "preferences", "functional", "unknown"]>;
+        consentTypeId: typeof Schema.String;
+    }>>;
+    readonly seedKnownCookies: import("../endpoint.js").Endpoint<"POST", "/privacy/known-cookies/seed", Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        seededCount: typeof Schema.Number;
+        message: typeof Schema.String;
+    }>>;
+};
+//# sourceMappingURL=privacy.d.ts.map

package/dist/endpoints/privacy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"privacy.d.ts","sourceRoot":"","sources":["../../src/endpoints/privacy.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAwB/B,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqFnB,CAAA"}

package/dist/endpoints/privacy.js

@@ -0,0 +1,98 @@
+/**
+ * Privacy endpoints — Console-plane cookie scanning + consent-type linking.
+ * Mirrors `apps/api/src/server/platform/routes/privacy.ts`.
+ *
+ * Production mount: `/privacy/*`.
+ */
+import { Schema } from 'effect';
+import { defineEndpoint } from '../endpoint.js';
+import { BulkLinkCookiesInput, BulkLinkCookiesResult, CookieScanSummary, LinkCookieInput, LinkCookieResult, ListCookiesQuery, ListCookiesResult, ListScansQuery, ListScansResult, ScanReport, SeedKnownCookiesResult, StartScanInput, StartScanResult, UpdateCookieCategoryInput, UpdateCookieCategoryResult, } from '../schemas/privacy.js';
+const ProjectIdPath = Schema.Struct({ id: Schema.String });
+const ProjectScanPath = Schema.Struct({ id: Schema.String, scanId: Schema.String });
+const ProjectCookiePath = Schema.Struct({ id: Schema.String, cookieId: Schema.String });
+export const privacyEndpoints = {
+    startScan: defineEndpoint({
+        method: 'POST',
+        path: '/privacy/scans',
+        body: StartScanInput,
+        response: StartScanResult,
+        plane: 'management',
+        summary: 'Queue a background job to scan a website for cookies',
+        tags: ['privacy'],
+    }),
+    getScan: defineEndpoint({
+        method: 'GET',
+        path: '/privacy/projects/:id/scans/:scanId',
+        params: ProjectScanPath,
+        response: ScanReport,
+        plane: 'management',
+        summary: 'Get a detailed scan report by ID',
+        tags: ['privacy'],
+    }),
+    listScans: defineEndpoint({
+        method: 'GET',
+        path: '/privacy/projects/:id/scans',
+        params: ProjectIdPath,
+        query: ListScansQuery,
+        response: ListScansResult,
+        plane: 'management',
+        summary: 'List all cookie scan reports for a project',
+        tags: ['privacy'],
+    }),
+    listCookies: defineEndpoint({
+        method: 'GET',
+        path: '/privacy/projects/:id/cookies',
+        params: ProjectIdPath,
+        query: ListCookiesQuery,
+        response: ListCookiesResult,
+        plane: 'management',
+        summary: 'Get detected cookies with filtering by category / party / search',
+        tags: ['privacy'],
+    }),
+    getSummary: defineEndpoint({
+        method: 'GET',
+        path: '/privacy/projects/:id/summary',
+        params: ProjectIdPath,
+        response: CookieScanSummary,
+        plane: 'management',
+        summary: 'Get aggregated statistics for cookie scans across a project',
+        tags: ['privacy'],
+    }),
+    updateCookieCategory: defineEndpoint({
+        method: 'PATCH',
+        path: '/privacy/projects/:id/cookies/:cookieId/category',
+        params: ProjectCookiePath,
+        body: UpdateCookieCategoryInput,
+        response: UpdateCookieCategoryResult,
+        plane: 'management',
+        summary: 'Update the category of a detected cookie',
+        tags: ['privacy'],
+    }),
+    linkCookie: defineEndpoint({
+        method: 'PATCH',
+        path: '/privacy/projects/:id/cookies/:cookieId/consent-type',
+        params: ProjectCookiePath,
+        body: LinkCookieInput,
+        response: LinkCookieResult,
+        plane: 'management',
+        summary: 'Link a cookie to a consent type (null to unlink)',
+        tags: ['privacy'],
+    }),
+    bulkLinkCookies: defineEndpoint({
+        method: 'POST',
+        path: '/privacy/cookies/bulk-link',
+        body: BulkLinkCookiesInput,
+        response: BulkLinkCookiesResult,
+        plane: 'management',
+        summary: 'Link all cookies in a category to a consent type',
+        tags: ['privacy'],
+    }),
+    seedKnownCookies: defineEndpoint({
+        method: 'POST',
+        path: '/privacy/known-cookies/seed',
+        response: SeedKnownCookiesResult,
+        plane: 'management',
+        summary: 'Seed the known cookie catalogue for automatic categorisation (admin only)',
+        tags: ['privacy'],
+    }),
+};