-- Deploy schemas/metaschema_modules_public/tables/api_surface_module/table to pg

-- requires: schemas/metaschema_modules_public/schema
-- requires: schemas/metaschema_modules_public/tables/catalog_module/table

BEGIN;

CREATE TABLE metaschema_modules_public.api_surface_module (
    id uuid PRIMARY KEY DEFAULT uuidv7(),
    database_id uuid NOT NULL,

    -- Scope-key column name on the generated table, recorded by the insert
    -- trigger via metaschema_generators.scope_key_column(scope, key).
    entity_field text,

    -- Schema reference (if uuid_nil, resolved from schema name or default)
    schema_id uuid NOT NULL DEFAULT uuid_nil(),

    -- Optional schema name override (used when schema_id is not provided)
    public_schema_name text,

    -- Catalog the apis register their owner-qualified identity into.
    -- Resolved by the insert trigger from the same-database catalog_module
    -- when NULL.
    catalog_module_id uuid,

    -- Generated table IDs (populated by the generator)
    apis_table_id uuid NOT NULL DEFAULT uuid_nil(),
    api_schemas_table_id uuid NOT NULL DEFAULT uuid_nil(),
    api_settings_table_id uuid NOT NULL DEFAULT uuid_nil(),
    cors_settings_table_id uuid NOT NULL DEFAULT uuid_nil(),

    -- Table names (input to the generator)
    apis_table_name text NOT NULL DEFAULT 'apis',
    api_schemas_table_name text NOT NULL DEFAULT 'api_schemas',
    api_settings_table_name text NOT NULL DEFAULT 'api_settings',
    cors_settings_table_name text NOT NULL DEFAULT 'cors_settings',

    -- API routing (get-or-create: if set, schema is added to this API)
    api_name text,
    private_api_name text,

    -- Scope: determines the security level for this module instance.
    scope text NOT NULL,

    -- Table name prefix. Auto-derived from scope by the trigger when empty.
    prefix text NOT NULL DEFAULT '',

    -- Entity table for RLS (NULL for non-entity scopes)
    entity_table_id uuid NULL,

    -- Configurable security policies (NULL = use defaults based on scope)
    policies jsonb NULL,

    -- Per-table provisions overrides from blueprint config
    provisions jsonb NULL,

    -- Default permissions: permission names auto-granted to new members
    default_permissions text[] DEFAULT NULL,

    CONSTRAINT api_module_db_fkey
        FOREIGN KEY (database_id)
        REFERENCES metaschema_public.database (id)
        ON DELETE CASCADE,
    CONSTRAINT api_module_schema_fkey
        FOREIGN KEY (schema_id)
        REFERENCES metaschema_public.schema (id)
        ON DELETE CASCADE,
    CONSTRAINT api_module_catalog_fkey
        FOREIGN KEY (catalog_module_id)
        REFERENCES metaschema_modules_public.catalog_module (id)
        ON DELETE CASCADE,
    CONSTRAINT api_module_apis_table_fkey
        FOREIGN KEY (apis_table_id)
        REFERENCES metaschema_public.table (id)
        ON DELETE CASCADE,
    CONSTRAINT api_module_api_schemas_table_fkey
        FOREIGN KEY (api_schemas_table_id)
        REFERENCES metaschema_public.table (id)
        ON DELETE CASCADE,
    CONSTRAINT api_module_api_settings_table_fkey
        FOREIGN KEY (api_settings_table_id)
        REFERENCES metaschema_public.table (id)
        ON DELETE CASCADE,
    CONSTRAINT api_module_cors_settings_table_fkey
        FOREIGN KEY (cors_settings_table_id)
        REFERENCES metaschema_public.table (id)
        ON DELETE CASCADE,
    CONSTRAINT api_module_entity_table_fkey
        FOREIGN KEY (entity_table_id)
        REFERENCES metaschema_public.table (id)
        ON DELETE CASCADE
);

CREATE UNIQUE INDEX api_module_unique_scope
    ON metaschema_modules_public.api_surface_module (database_id, scope);
CREATE INDEX api_surface_module_api_schemas_table_id_idx ON metaschema_modules_public.api_surface_module ( api_schemas_table_id );
CREATE INDEX api_surface_module_api_settings_table_id_idx ON metaschema_modules_public.api_surface_module ( api_settings_table_id );
CREATE INDEX api_surface_module_apis_table_id_idx ON metaschema_modules_public.api_surface_module ( apis_table_id );
CREATE INDEX api_surface_module_cors_settings_table_id_idx ON metaschema_modules_public.api_surface_module ( cors_settings_table_id );
CREATE INDEX api_surface_module_entity_table_id_idx ON metaschema_modules_public.api_surface_module ( entity_table_id );
CREATE INDEX api_surface_module_schema_id_idx ON metaschema_modules_public.api_surface_module ( schema_id );
CREATE INDEX api_surface_module_catalog_module_id_idx ON metaschema_modules_public.api_surface_module ( catalog_module_id );

COMMIT;
