@spacefast/common 0.0.2

package/dist/contracts/access.d.ts

@@ -0,0 +1,409 @@
+import { z } from "zod";
+export declare const grantSchema: z.ZodString;
+export type Grant = z.infer<typeof grantSchema>;
+export declare const GRANT_NAMESPACES: readonly ["email:", "team:", "sub-team:", "user:", "svc:", "ext:", "email-domain:", "space:", "link:", "sso:", "pw:"];
+export type GrantNamespace = (typeof GRANT_NAMESPACES)[number];
+export declare function isWellFormedGrant(grant: string): boolean;
+export declare const requiredGrantSchema: z.ZodString;
+export type RequiredGrant = z.infer<typeof requiredGrantSchema>;
+export declare const accessKeySchema: z.ZodObject<{
+    kid: z.ZodString;
+    alg: z.ZodLiteral<"EdDSA">;
+    publicKey: z.ZodString;
+    grantNamespaces: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type AccessKey = z.infer<typeof accessKeySchema>;
+export declare const passwordAuthSchema: z.ZodObject<{
+    ref: z.ZodString;
+    transport: z.ZodEnum<{
+        basic: "basic";
+        form: "form";
+    }>;
+    username: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type PasswordAuth = z.infer<typeof passwordAuthSchema>;
+export declare const tokenAuthSchema: z.ZodObject<{
+    requiredGrants: z.ZodArray<z.ZodString>;
+    issuers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        kid: z.ZodString;
+        alg: z.ZodLiteral<"EdDSA">;
+        publicKey: z.ZodString;
+        grantNamespaces: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>>;
+    loginUrl: z.ZodOptional<z.ZodString>;
+    cookieName: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type TokenAuth = z.infer<typeof tokenAuthSchema>;
+export declare const ruleAuthSchema: z.ZodObject<{
+    password: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+        transport: z.ZodEnum<{
+            basic: "basic";
+            form: "form";
+        }>;
+        username: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    token: z.ZodOptional<z.ZodObject<{
+        requiredGrants: z.ZodArray<z.ZodString>;
+        issuers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            kid: z.ZodString;
+            alg: z.ZodLiteral<"EdDSA">;
+            publicKey: z.ZodString;
+            grantNamespaces: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>>>;
+        loginUrl: z.ZodOptional<z.ZodString>;
+        cookieName: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type RuleAuth = z.infer<typeof ruleAuthSchema>;
+export declare const ruleMatchSchema: z.ZodObject<{
+    host: z.ZodOptional<z.ZodString>;
+    pathPattern: z.ZodOptional<z.ZodString>;
+    channel: z.ZodOptional<z.ZodString>;
+    ipCidrs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    agent: z.ZodOptional<z.ZodString>;
+    country: z.ZodOptional<z.ZodString>;
+    header: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type RuleMatch = z.infer<typeof ruleMatchSchema>;
+export declare const runtimeRuleSchema: z.ZodObject<{
+    match: z.ZodDefault<z.ZodObject<{
+        host: z.ZodOptional<z.ZodString>;
+        pathPattern: z.ZodOptional<z.ZodString>;
+        channel: z.ZodOptional<z.ZodString>;
+        ipCidrs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        agent: z.ZodOptional<z.ZodString>;
+        country: z.ZodOptional<z.ZodString>;
+        header: z.ZodOptional<z.ZodObject<{
+            name: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    effect: z.ZodEnum<{
+        allow: "allow";
+        deny: "deny";
+        challenge: "challenge";
+    }>;
+    auth: z.ZodOptional<z.ZodObject<{
+        password: z.ZodOptional<z.ZodObject<{
+            ref: z.ZodString;
+            transport: z.ZodEnum<{
+                basic: "basic";
+                form: "form";
+            }>;
+            username: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        token: z.ZodOptional<z.ZodObject<{
+            requiredGrants: z.ZodArray<z.ZodString>;
+            issuers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                kid: z.ZodString;
+                alg: z.ZodLiteral<"EdDSA">;
+                publicKey: z.ZodString;
+                grantNamespaces: z.ZodArray<z.ZodString>;
+            }, z.core.$strip>>>;
+            loginUrl: z.ZodOptional<z.ZodString>;
+            cookieName: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    reasonCode: z.ZodOptional<z.ZodString>;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type RuntimeRule = z.infer<typeof runtimeRuleSchema>;
+export declare const ACCESS_TOKEN_COOKIE_NAME = "stattic_access";
+export declare const ACCESS_TOKEN_KID = "stattic-runtime-v1";
+export declare const ACCESS_TOKEN_ALG = "EdDSA";
+export declare const CAST_TOKEN_KID = "spacefast-cast-v1";
+export declare const accessTokenPayloadSchema: z.ZodObject<{
+    sub: z.ZodString;
+    grants: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    exp: z.ZodNumber;
+    nbf: z.ZodOptional<z.ZodNumber>;
+    iat: z.ZodOptional<z.ZodNumber>;
+    iss: z.ZodOptional<z.ZodString>;
+    aud: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type AccessTokenPayload = z.infer<typeof accessTokenPayloadSchema>;
+export declare const authorizeRequestSchema: z.ZodObject<{
+    setCookie: z.ZodDefault<z.ZodBoolean>;
+    aud: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type AuthorizeRequest = z.infer<typeof authorizeRequestSchema>;
+export declare const authorizeResponseSchema: z.ZodObject<{
+    token: z.ZodString;
+    payload: z.ZodObject<{
+        sub: z.ZodString;
+        grants: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        exp: z.ZodNumber;
+        nbf: z.ZodOptional<z.ZodNumber>;
+        iat: z.ZodOptional<z.ZodNumber>;
+        iss: z.ZodOptional<z.ZodString>;
+        aud: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    expiresAt: z.ZodNumber;
+    cookieName: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type AuthorizeResponse = z.infer<typeof authorizeResponseSchema>;
+export declare function spaceViewerGrant(spaceId: string): string;
+export declare function spaceLevelGrant(spaceId: string, level: string): string;
+export declare function shareLinkGrant(linkId: string): string;
+export declare const inviteCreateRequestSchema: z.ZodObject<{
+    email: z.ZodString;
+    expiresInDays: z.ZodOptional<z.ZodNumber>;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type InviteCreateRequest = z.infer<typeof inviteCreateRequestSchema>;
+export declare const spaceInviteSchema: z.ZodObject<{
+    id: z.ZodString;
+    spaceId: z.ZodString;
+    email: z.ZodString;
+    status: z.ZodEnum<{
+        pending: "pending";
+        accepted: "accepted";
+        revoked: "revoked";
+        expired: "expired";
+    }>;
+    grant: z.ZodString;
+    invitedBy: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    expiresAt: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    acceptedAt: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    revokedAt: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+export type SpaceInvite = z.infer<typeof spaceInviteSchema>;
+export declare const shareLinkCreateRequestSchema: z.ZodObject<{
+    pathPrefix: z.ZodDefault<z.ZodString>;
+    expiresAt: z.ZodOptional<z.ZodString>;
+    label: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ShareLinkCreateRequest = z.infer<typeof shareLinkCreateRequestSchema>;
+export declare const shareLinkSchema: z.ZodObject<{
+    id: z.ZodString;
+    spaceId: z.ZodString;
+    pathPrefix: z.ZodString;
+    label: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    grant: z.ZodString;
+    url: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    createdBy: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    expiresAt: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    revokedAt: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+export type ShareLink = z.infer<typeof shareLinkSchema>;
+export declare const channelSchema: z.ZodObject<{
+    name: z.ZodString;
+    versionId: z.ZodString;
+    history: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        versionId: z.ZodString;
+        at: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type Channel = z.infer<typeof channelSchema>;
+export declare const servingConfigSchema: z.ZodObject<{
+    index: z.ZodOptional<z.ZodString>;
+    fallback: z.ZodOptional<z.ZodString>;
+    listing: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type ServingConfig = z.infer<typeof servingConfigSchema>;
+export declare const policyDocSchema: z.ZodObject<{
+    rules: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        match: z.ZodDefault<z.ZodObject<{
+            host: z.ZodOptional<z.ZodString>;
+            pathPattern: z.ZodOptional<z.ZodString>;
+            channel: z.ZodOptional<z.ZodString>;
+            ipCidrs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            agent: z.ZodOptional<z.ZodString>;
+            country: z.ZodOptional<z.ZodString>;
+            header: z.ZodOptional<z.ZodObject<{
+                name: z.ZodString;
+                value: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        effect: z.ZodEnum<{
+            allow: "allow";
+            deny: "deny";
+            challenge: "challenge";
+        }>;
+        auth: z.ZodOptional<z.ZodObject<{
+            password: z.ZodOptional<z.ZodObject<{
+                ref: z.ZodString;
+                transport: z.ZodEnum<{
+                    basic: "basic";
+                    form: "form";
+                }>;
+                username: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+            token: z.ZodOptional<z.ZodObject<{
+                requiredGrants: z.ZodArray<z.ZodString>;
+                issuers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    kid: z.ZodString;
+                    alg: z.ZodLiteral<"EdDSA">;
+                    publicKey: z.ZodString;
+                    grantNamespaces: z.ZodArray<z.ZodString>;
+                }, z.core.$strip>>>;
+                loginUrl: z.ZodOptional<z.ZodString>;
+                cookieName: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        reasonCode: z.ZodOptional<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type PolicyDoc = z.infer<typeof policyDocSchema>;
+export declare const spacePolicySchema: z.ZodObject<{
+    rules: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        match: z.ZodDefault<z.ZodObject<{
+            host: z.ZodOptional<z.ZodString>;
+            pathPattern: z.ZodOptional<z.ZodString>;
+            channel: z.ZodOptional<z.ZodString>;
+            ipCidrs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            agent: z.ZodOptional<z.ZodString>;
+            country: z.ZodOptional<z.ZodString>;
+            header: z.ZodOptional<z.ZodObject<{
+                name: z.ZodString;
+                value: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        effect: z.ZodEnum<{
+            allow: "allow";
+            deny: "deny";
+            challenge: "challenge";
+        }>;
+        auth: z.ZodOptional<z.ZodObject<{
+            password: z.ZodOptional<z.ZodObject<{
+                ref: z.ZodString;
+                transport: z.ZodEnum<{
+                    basic: "basic";
+                    form: "form";
+                }>;
+                username: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+            token: z.ZodOptional<z.ZodObject<{
+                requiredGrants: z.ZodArray<z.ZodString>;
+                issuers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    kid: z.ZodString;
+                    alg: z.ZodLiteral<"EdDSA">;
+                    publicKey: z.ZodString;
+                    grantNamespaces: z.ZodArray<z.ZodString>;
+                }, z.core.$strip>>>;
+                loginUrl: z.ZodOptional<z.ZodString>;
+                cookieName: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        reasonCode: z.ZodOptional<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    version: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+export type SpacePolicy = z.infer<typeof spacePolicySchema>;
+export declare const ruleSourceSchema: z.ZodEnum<{
+    file: "file";
+    platform: "platform";
+    cloud: "cloud";
+}>;
+export type RuleSource = z.infer<typeof ruleSourceSchema>;
+export declare const effectiveRuleSchema: z.ZodObject<{
+    match: z.ZodDefault<z.ZodObject<{
+        host: z.ZodOptional<z.ZodString>;
+        pathPattern: z.ZodOptional<z.ZodString>;
+        channel: z.ZodOptional<z.ZodString>;
+        ipCidrs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        agent: z.ZodOptional<z.ZodString>;
+        country: z.ZodOptional<z.ZodString>;
+        header: z.ZodOptional<z.ZodObject<{
+            name: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    effect: z.ZodEnum<{
+        allow: "allow";
+        deny: "deny";
+        challenge: "challenge";
+    }>;
+    auth: z.ZodOptional<z.ZodObject<{
+        password: z.ZodOptional<z.ZodObject<{
+            ref: z.ZodString;
+            transport: z.ZodEnum<{
+                basic: "basic";
+                form: "form";
+            }>;
+            username: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        token: z.ZodOptional<z.ZodObject<{
+            requiredGrants: z.ZodArray<z.ZodString>;
+            issuers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                kid: z.ZodString;
+                alg: z.ZodLiteral<"EdDSA">;
+                publicKey: z.ZodString;
+                grantNamespaces: z.ZodArray<z.ZodString>;
+            }, z.core.$strip>>>;
+            loginUrl: z.ZodOptional<z.ZodString>;
+            cookieName: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    reasonCode: z.ZodOptional<z.ZodString>;
+    message: z.ZodOptional<z.ZodString>;
+    source: z.ZodEnum<{
+        file: "file";
+        platform: "platform";
+        cloud: "cloud";
+    }>;
+    order: z.ZodNumber;
+}, z.core.$strip>;
+export type EffectiveRule = z.infer<typeof effectiveRuleSchema>;
+export declare const effectivePolicySchema: z.ZodObject<{
+    rules: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        match: z.ZodDefault<z.ZodObject<{
+            host: z.ZodOptional<z.ZodString>;
+            pathPattern: z.ZodOptional<z.ZodString>;
+            channel: z.ZodOptional<z.ZodString>;
+            ipCidrs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            agent: z.ZodOptional<z.ZodString>;
+            country: z.ZodOptional<z.ZodString>;
+            header: z.ZodOptional<z.ZodObject<{
+                name: z.ZodString;
+                value: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        effect: z.ZodEnum<{
+            allow: "allow";
+            deny: "deny";
+            challenge: "challenge";
+        }>;
+        auth: z.ZodOptional<z.ZodObject<{
+            password: z.ZodOptional<z.ZodObject<{
+                ref: z.ZodString;
+                transport: z.ZodEnum<{
+                    basic: "basic";
+                    form: "form";
+                }>;
+                username: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+            token: z.ZodOptional<z.ZodObject<{
+                requiredGrants: z.ZodArray<z.ZodString>;
+                issuers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    kid: z.ZodString;
+                    alg: z.ZodLiteral<"EdDSA">;
+                    publicKey: z.ZodString;
+                    grantNamespaces: z.ZodArray<z.ZodString>;
+                }, z.core.$strip>>>;
+                loginUrl: z.ZodOptional<z.ZodString>;
+                cookieName: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        reasonCode: z.ZodOptional<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+        source: z.ZodEnum<{
+            file: "file";
+            platform: "platform";
+            cloud: "cloud";
+        }>;
+        order: z.ZodNumber;
+    }, z.core.$strip>>>;
+    cloudVersion: z.ZodDefault<z.ZodNumber>;
+    fileVersion: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    secrets: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strip>;
+export type EffectivePolicy = z.infer<typeof effectivePolicySchema>;