import * as dlp from "@distilled.cloud/gcp/dlp_v2";
import { Unowned } from "alchemy/AdoptPolicy";
import { isResolved } from "alchemy/Diff";
import * as Provider from "alchemy/Provider";
import { Resource } from "alchemy/Resource";
import * as Effect from "effect/Effect";
import * as Stream from "effect/Stream";
import { GcpEnvironment } from "../Environment.ts";
import { createInternalLabels } from "../Labels.ts";
import type { Providers } from "../Providers.ts";
import {
DlpNotResolved,
encodeDescription,
fingerprint,
hasOwnershipMarker,
lastSegment,
organizationIdOf,
ownedByAlchemy,
parseName,
parseOwnership,
replaceOn,
resolveOrganization,
sameText,
toPhysicalId,
tryResolveOrganization,
updateMaskOf,
} from "./internal.ts";
export type DeidentifyConfig = dlp.GooglePrivacyDlpV2DeidentifyConfig;
export type OrganizationsDeidentifyTemplateProps = {
/**
* Template id (the `{deidentifyTemplate}` segment of
* `organizations/{organization}/deidentifyTemplates/{deidentifyTemplate}`).
* If omitted, a unique id is generated from the stack, stage, and
* logical id. Letters, digits, hyphens, and underscores; max 100
* characters. Immutable — changing it replaces the template.
*/
templateId?: string;
/**
* Parent organization (`organizations/{organization}` or the numeric
* id). Defaults to `GOOGLE_ORGANIZATION_ID` or the project's Resource
* Manager ancestor. Immutable — changing it replaces the template.
*/
organization?: string;
/**
* Human-readable display name (max 256 characters).
*/
displayName?: string;
/**
* Human-readable description (max 256 characters). Deidentify templates
* have no labels field, so Alchemy ownership is stored in a
* `[alchemy …]` prefix and stripped from attributes.
*/
description?: string;
/**
* De-identification configuration applied when this template is used.
*/
deidentifyConfig: DeidentifyConfig;
};
export type OrganizationsDeidentifyTemplate = Resource<
"GCP.DLP.OrganizationsDeidentifyTemplate",
OrganizationsDeidentifyTemplateProps,
{
/** Full resource name `organizations/{organization}/deidentifyTemplates/{deidentifyTemplate}`. */
name: string;
/** Template id (last path segment). */
templateId: string;
/** Organization resource name. */
organization: string;
/** Organization id. */
organizationId: string;
/** Project id of the deploying stack. */
project: string;
/** User display name. */
displayName: string | undefined;
/** User description with the Alchemy ownership prefix stripped. */
description: string | undefined;
/** De-identification configuration. */
deidentifyConfig: DeidentifyConfig | undefined;
/** RFC3339 creation timestamp. */
createTime: string | undefined;
/** RFC3339 last-update timestamp. */
updateTime: string | undefined;
},
never,
Providers
>;
/**
* An organization-scoped Sensitive Data Protection de-identify template.
*
* Templates have no labels field — Alchemy stamps ownership into the
* description so `list` / nuke can find them. Template id and organization
* are identity. Display name, description, and de-identify config update
* in place.
*
* ### Creating a Deidentify Template
* **Example:** Redact matched infoTypes
* ```typescript
* const template = yield* GCP.DLP.OrganizationsDeidentifyTemplate(
* "RedactEmail",
* {
* displayName: "redact-email",
* deidentifyConfig: {
* infoTypeTransformations: {
* transformations: [
* {
* primitiveTransformation: { replaceWithInfoTypeConfig: {} },
* },
* ],
* },
* },
* },
* );
* ```
*
* **Example:** Named template on an explicit organization
* ```typescript
* const template = yield* GCP.DLP.OrganizationsDeidentifyTemplate(
* "RedactEmail",
* {
* organization: "organizations/123456789",
* templateId: "redact-email",
* deidentifyConfig: {
* infoTypeTransformations: {
* transformations: [
* {
* primitiveTransformation: { replaceWithInfoTypeConfig: {} },
* },
* ],
* },
* },
* },
* );
* ```
*
* @resource
* @category DLP
*/
export const OrganizationsDeidentifyTemplate = Resource<OrganizationsDeidentifyTemplate>(
"GCP.DLP.OrganizationsDeidentifyTemplate",
);
const resourceName = (organization: string, templateId: string) =>
`${organization}/deidentifyTemplates/${templateId}`;
const toAttrs = (
template: dlp.GooglePrivacyDlpV2DeidentifyTemplate,
organization: string,
project: string,
) => {
const name = template.name ?? "";
const parsed = parseName(name, "deidentifyTemplates");
const ownership = parseOwnership(template.description);
return {
name,
templateId: parsed.id || lastSegment(name),
organization,
organizationId: organizationIdOf(organization),
project,
displayName: template.displayName,
description: ownership.text,
deidentifyConfig: template.deidentifyConfig,
createTime: template.createTime,
updateTime: template.updateTime,
};
};
const getByName = (name: string) =>
name.length === 0
? Effect.undefined
: dlp
.getOrganizationsDeidentifyTemplates({ name })
.pipe(Effect.catchTag("NotFound", () => Effect.undefined));
export const OrganizationsDeidentifyTemplateProvider = () =>
Provider.succeed(OrganizationsDeidentifyTemplate, {
stables: ["name", "templateId", "organization", "organizationId", "project", "createTime"],
diff: Effect.fn(function* ({ news, olds, output }) {
if (!isResolved(news)) return undefined;
return (
replaceOn(olds?.templateId ?? output?.templateId, news.templateId) ??
replaceOn(olds?.organization ?? output?.organization, news.organization)
);
}),
read: Effect.fn(function* ({ id, olds, output }) {
const env = yield* GcpEnvironment.current;
const organization = yield* resolveOrganization(
olds?.organization ?? output?.organization,
output?.organization,
);
const templateId = yield* toPhysicalId(id, olds?.templateId, output?.templateId);
const name = output?.name ?? resourceName(organization, templateId);
const existing = yield* getByName(name);
if (existing === undefined) return undefined;
const attrs = toAttrs(existing, organization, env.project);
return (yield* ownedByAlchemy(id, existing.description)) ? attrs : Unowned(attrs);
}),
list: () =>
Effect.gen(function* () {
const env = yield* GcpEnvironment.current;
const organization = yield* tryResolveOrganization();
if (organization === undefined) return [];
return yield* dlp.listOrganizationsDeidentifyTemplates
.pages({ parent: organization, pageSize: 100 })
.pipe(
Stream.flatMap((page) => Stream.fromIterable(page.deidentifyTemplates ?? [])),
Stream.filter((template) => hasOwnershipMarker(template.description)),
Stream.map((template) => toAttrs(template, organization, env.project)),
Stream.runCollect,
Effect.map((chunk) => Array.from(chunk)),
Effect.catchTag("NotFound", () => Effect.succeed([])),
);
}),
reconcile: Effect.fn(function* ({ id, news, output }) {
const env = yield* GcpEnvironment.current;
const organization = yield* resolveOrganization(news.organization, output?.organization);
const templateId = yield* toPhysicalId(id, news.templateId, output?.templateId);
const name = resourceName(organization, templateId);
const ownership = yield* createInternalLabels(id);
const description = encodeDescription(ownership, news.description);
const displayName = news.displayName;
const deidentifyConfig = news.deidentifyConfig;
let current = yield* getByName(output?.name ?? name);
if (current === undefined) {
const created = yield* dlp
.createOrganizationsDeidentifyTemplates({
parent: organization,
body: {
templateId,
deidentifyTemplate: {
displayName,
description,
deidentifyConfig,
},
},
})
.pipe(Effect.catchTag("Conflict", () => getByName(name)));
current = created ?? undefined;
}
if (current === undefined) {
return yield* new DlpNotResolved({ resourceName: name });
}
const currentName = current.name ?? name;
const displayChanged = !sameText(current.displayName, displayName);
const descriptionChanged = !sameText(current.description, description);
const configChanged = fingerprint(current.deidentifyConfig) !== fingerprint(deidentifyConfig);
const updateMask = updateMaskOf(
displayChanged ? "displayName" : undefined,
descriptionChanged ? "description" : undefined,
configChanged ? "deidentifyConfig" : undefined,
);
if (updateMask.length > 0) {
current = yield* dlp.patchOrganizationsDeidentifyTemplates({
name: currentName,
body: {
updateMask,
deidentifyTemplate: {
displayName,
description,
deidentifyConfig,
},
},
});
}
return toAttrs(current, organization, env.project);
}),
delete: Effect.fn(function* ({ output }) {
yield* dlp
.deleteOrganizationsDeidentifyTemplates({ name: output.name })
.pipe(Effect.catchTag("NotFound", () => Effect.void));
}),
});