sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ VerifiedPermissions/ Schema.ts

import * as avp from "@distilled.cloud/aws/verifiedpermissions";
import { isResolved } from "alchemy/Diff";
import * as Provider from "alchemy/Provider";
import { Resource } from "alchemy/Resource";
import * as Effect from "effect/Effect";
import type { Providers } from "../Providers.ts";

export interface SchemaProps {
  /**
   * The ID of the policy store the schema belongs to. A store has at most one
   * schema. Changing the store replaces the schema.
   */
  policyStoreId: string;
  /**
   * The Cedar JSON schema document (as a JSON string). Defines the entity
   * types, actions, and the relationships between them used to validate
   * policies when the store's validation mode is `STRICT`. Mutable — updating
   * re-submits the schema via `PutSchema`.
   */
  cedarJson: string;
}

export interface Schema extends Resource<
  "AWS.VerifiedPermissions.Schema",
  SchemaProps,
  {
    /**
     * ID of the policy store the schema belongs to.
     */
    policyStoreId: string;
  },
  {},
  Providers
> {}

/**
 * The Cedar schema for a Verified Permissions policy store. The schema
 * declares the entity types and actions your policies reference; with
 * `validationMode: "STRICT"` on the store, policies and templates are
 * validated against it at submission time.
 *
 * A policy store has at most one schema — `PutSchema` is an upsert that fully
 * replaces the previous schema.
 * ### Defining a Schema
 * **Example:** Photo App Schema
 * ```typescript
 * import * as AWS from "@alchemy.run/aws";
 *
 * const store = yield* AWS.VerifiedPermissions.PolicyStore("Store", {
 *   validationMode: "STRICT",
 * });
 *
 * yield* AWS.VerifiedPermissions.Schema("Schema", {
 *   policyStoreId: store.policyStoreId,
 *   cedarJson: JSON.stringify({
 *     PhotoApp: {
 *       entityTypes: {
 *         User: {},
 *         Photo: {},
 *       },
 *       actions: {
 *         viewPhoto: {
 *           appliesTo: {
 *             principalTypes: ["User"],
 *             resourceTypes: ["Photo"],
 *           },
 *         },
 *       },
 *     },
 *   }),
 * });
 * ```
 *
 * @resource
 */
export const Schema = Resource<Schema>("AWS.VerifiedPermissions.Schema");

export const SchemaProvider = () =>
  Provider.effect(
    Schema,
    Effect.gen(function* () {
      return Schema.Provider.of({
        stables: ["policyStoreId"],

        // singleton child of a policy store — not enumerable account-wide
        list: () => Effect.succeed([]),

        read: Effect.fn(function* ({ olds, output }) {
          const policyStoreId = output?.policyStoreId ?? olds?.policyStoreId;
          if (policyStoreId === undefined) return undefined;
          const schema = yield* avp
            .getSchema({ policyStoreId })
            .pipe(Effect.catchTag("ResourceNotFoundException", () => Effect.undefined));
          if (schema === undefined) return undefined;
          return { policyStoreId };
        }),

        diff: Effect.fn(function* ({ news, olds }) {
          if (!isResolved(news)) return undefined;
          if (olds.policyStoreId !== news.policyStoreId) {
            return { action: "replace" } as const;
          }
          // cedarJson is mutable → default update path
        }),

        reconcile: Effect.fn(function* ({ news, session }) {
          // PutSchema is a full upsert — idempotent for both create and update
          yield* avp.putSchema({
            policyStoreId: news.policyStoreId,
            definition: { cedarJson: news.cedarJson },
          });
          yield* session.note(news.policyStoreId);
          return { policyStoreId: news.policyStoreId };
        }),

        delete: Effect.fn(function* () {
          // Verified Permissions has no DeleteSchema API — the schema is
          // removed when the policy store is deleted. Nothing to do.
          yield* Effect.void;
        }),
      });
    }),
  );