The best way to control Claude Code, Codex and more from any computer or phone
| 1 | import * as datalabeling from "@distilled.cloud/gcp/datalabeling_v1beta1"; |
| 2 | import { Unowned } from "alchemy/AdoptPolicy"; |
| 3 | import { isResolved } from "alchemy/Diff"; |
| 4 | import * as Provider from "alchemy/Provider"; |
| 5 | import { Resource } from "alchemy/Resource"; |
| 6 | import * as Data from "effect/Data"; |
| 7 | import * as Effect from "effect/Effect"; |
| 8 | import { GcpEnvironment } from "../Environment.ts"; |
| 9 | import { createInternalLabels } from "../Labels.ts"; |
| 10 | import type { Providers } from "../Providers.ts"; |
| 11 | import { |
| 12 | encodeOwnership, |
| 13 | findOwned, |
| 14 | hasOwnershipMarker, |
| 15 | ignoreGone, |
| 16 | listInstructions, |
| 17 | noRetryLayer, |
| 18 | ownedByAlchemy, |
| 19 | parseOwnership, |
| 20 | parseResourceName, |
| 21 | projectParent, |
| 22 | replaceOnIdentity, |
| 23 | retryDelete, |
| 24 | retryTransient, |
| 25 | sameJson, |
| 26 | sameText, |
| 27 | toDisplayName, |
| 28 | waitForVisible, |
| 29 | waitUntilGone, |
| 30 | } from "./internal.ts"; |
| 31 | import { resourceNameFromOperation, waitForOperation } from "./operations.ts"; |
| 32 | |
| 33 | export type InstructionDataType = |
| 34 | datalabeling.GoogleCloudDatalabelingV1beta1InstructionDataTypeEnum; |
| 35 | |
| 36 | export type PdfInstruction = { |
| 37 | /** |
| 38 | * Cloud Storage URI of the PDF (`gs://...`). |
| 39 | */ |
| 40 | gcsFileUri?: string; |
| 41 | }; |
| 42 | |
| 43 | export type CsvInstruction = { |
| 44 | /** |
| 45 | * Cloud Storage URI of the CSV (`gs://...`). Deprecated — the API |
| 46 | * only accepts PDF instructions. |
| 47 | */ |
| 48 | gcsFileUri?: string; |
| 49 | }; |
| 50 | |
| 51 | export type InstructionProps = { |
| 52 | /** |
| 53 | * Instruction id (the last segment of |
| 54 | * `projects/{project}/instructions/{instruction}`). Server-assigned |
| 55 | * on create. Immutable — changing it replaces the instruction. |
| 56 | */ |
| 57 | instructionId?: string; |
| 58 | /** |
| 59 | * Display name. Maximum 64 characters. Required by the API; Alchemy |
| 60 | * falls back to a generated name. Immutable — changing it replaces |
| 61 | * the instruction. |
| 62 | */ |
| 63 | displayName?: string; |
| 64 | /** |
| 65 | * Data type this instruction applies to (`IMAGE`, `VIDEO`, `TEXT`, |
| 66 | * `GENERAL_DATA`). Immutable — changing it replaces the instruction. |
| 67 | */ |
| 68 | dataType: InstructionDataType | (string & {}); |
| 69 | /** |
| 70 | * Human-readable description. Instructions have no labels field, so |
| 71 | * Alchemy stamps ownership into this field. Immutable — changing it |
| 72 | * replaces the instruction. |
| 73 | */ |
| 74 | description?: string; |
| 75 | /** |
| 76 | * PDF instruction stored in Cloud Storage. Currently the only |
| 77 | * supported instruction format. Immutable — changing it replaces the |
| 78 | * instruction. |
| 79 | */ |
| 80 | pdfInstruction?: PdfInstruction; |
| 81 | /** |
| 82 | * Deprecated CSV instruction. Immutable — changing it replaces the |
| 83 | * instruction. |
| 84 | */ |
| 85 | csvInstruction?: CsvInstruction; |
| 86 | }; |
| 87 | |
| 88 | export type Instruction = Resource< |
| 89 | "GCP.DataLabeling.Instruction", |
| 90 | InstructionProps, |
| 91 | { |
| 92 | /** Full resource name `projects/{project}/instructions/{instruction}`. */ |
| 93 | name: string; |
| 94 | /** Instruction id (last path segment). */ |
| 95 | instructionId: string; |
| 96 | /** Project id. */ |
| 97 | project: string; |
| 98 | /** Display name. */ |
| 99 | displayName: string | undefined; |
| 100 | /** Data type this instruction applies to. */ |
| 101 | dataType: string | undefined; |
| 102 | /** User description with the Alchemy ownership prefix stripped. */ |
| 103 | description: string | undefined; |
| 104 | /** PDF instruction, if set. */ |
| 105 | pdfInstruction: PdfInstruction | undefined; |
| 106 | /** Deprecated CSV instruction, if set. */ |
| 107 | csvInstruction: CsvInstruction | undefined; |
| 108 | /** RFC3339 creation timestamp. */ |
| 109 | createTime: string | undefined; |
| 110 | /** RFC3339 last-update timestamp. */ |
| 111 | updateTime: string | undefined; |
| 112 | /** Related resources blocking changes. */ |
| 113 | blockingResources: string[] | undefined; |
| 114 | }, |
| 115 | never, |
| 116 | Providers |
| 117 | >; |
| 118 | |
| 119 | /** |
| 120 | * A Data Labeling instruction describing how human operators should |
| 121 | * label data. Create is a long-running operation. The current API only |
| 122 | * accepts a PDF stored in Cloud Storage. |
| 123 | * |
| 124 | * Instruction ids are server-assigned. There is no labels API, so |
| 125 | * Alchemy stamps ownership into `description` so `list` / nuke can find |
| 126 | * them. All input fields are immutable — changing them replaces the |
| 127 | * instruction. |
| 128 | * |
| 129 | * ### Creating an Instruction |
| 130 | * **Example:** Image labeling PDF |
| 131 | * ```typescript |
| 132 | * const instruction = yield* GCP.DataLabeling.Instruction("HowTo", { |
| 133 | * displayName: "image-classes", |
| 134 | * dataType: "IMAGE", |
| 135 | * pdfInstruction: { |
| 136 | * gcsFileUri: "gs://my-bucket/instructions.pdf", |
| 137 | * }, |
| 138 | * }); |
| 139 | * ``` |
| 140 | * |
| 141 | * **Example:** Text labeling PDF with a description |
| 142 | * ```typescript |
| 143 | * const instruction = yield* GCP.DataLabeling.Instruction("HowTo", { |
| 144 | * displayName: "entity-extraction", |
| 145 | * dataType: "TEXT", |
| 146 | * description: "highlight product names", |
| 147 | * pdfInstruction: { |
| 148 | * gcsFileUri: "gs://my-bucket/text-instructions.pdf", |
| 149 | * }, |
| 150 | * }); |
| 151 | * ``` |
| 152 | * |
| 153 | * @resource |
| 154 | * @category DataLabeling |
| 155 | */ |
| 156 | export const Instruction = Resource<Instruction>("GCP.DataLabeling.Instruction"); |
| 157 | |
| 158 | export class InstructionNotResolved extends Data.TaggedError( |
| 159 | "GCP.DataLabeling.InstructionNotResolved", |
| 160 | )<{ |
| 161 | resourceName: string; |
| 162 | }> {} |
| 163 | |
| 164 | const resourceName = (project: string, instructionId: string) => |
| 165 | `${projectParent(project)}/instructions/${instructionId}`; |
| 166 | |
| 167 | const toAttrs = ( |
| 168 | instruction: datalabeling.GoogleCloudDatalabelingV1beta1Instruction, |
| 169 | project: string, |
| 170 | ) => { |
| 171 | const name = instruction.name ?? ""; |
| 172 | const parsed = parseResourceName(name, "instructions"); |
| 173 | return { |
| 174 | name, |
| 175 | instructionId: parsed.id, |
| 176 | project: parsed.project || project, |
| 177 | displayName: instruction.displayName, |
| 178 | dataType: instruction.dataType, |
| 179 | description: parseOwnership(instruction.description).text, |
| 180 | pdfInstruction: instruction.pdfInstruction, |
| 181 | csvInstruction: instruction.csvInstruction, |
| 182 | createTime: instruction.createTime, |
| 183 | updateTime: instruction.updateTime, |
| 184 | blockingResources: instruction.blockingResources, |
| 185 | }; |
| 186 | }; |
| 187 | |
| 188 | const getByName = (name: string) => |
| 189 | name.length === 0 |
| 190 | ? Effect.undefined |
| 191 | : datalabeling.getProjectsInstructions({ name }).pipe( |
| 192 | Effect.provide(noRetryLayer), |
| 193 | Effect.catchTags({ |
| 194 | NotFound: () => Effect.undefined, |
| 195 | BadGateway: () => Effect.undefined, |
| 196 | }), |
| 197 | ); |
| 198 | |
| 199 | const findByOwnership = (id: string, project: string) => |
| 200 | Effect.gen(function* () { |
| 201 | const rows = yield* listInstructions(projectParent(project)); |
| 202 | return yield* findOwned(id, rows, (row) => row.description); |
| 203 | }); |
| 204 | |
| 205 | export const InstructionProvider = () => |
| 206 | Provider.succeed(Instruction, { |
| 207 | stables: ["name", "instructionId", "project", "createTime"], |
| 208 | |
| 209 | diff: Effect.fn(function* ({ news, olds, output }) { |
| 210 | if (!isResolved(news)) return undefined; |
| 211 | const extra = |
| 212 | (news.displayName !== undefined && |
| 213 | output?.displayName !== undefined && |
| 214 | !sameText(news.displayName, output.displayName)) || |
| 215 | (output?.dataType !== undefined && !sameText(news.dataType, output.dataType)) || |
| 216 | (olds !== undefined && !sameText(news.description, output?.description)) || |
| 217 | (output !== undefined && !sameJson(news.pdfInstruction, output.pdfInstruction)) || |
| 218 | (output !== undefined && !sameJson(news.csvInstruction, output.csvInstruction)); |
| 219 | return replaceOnIdentity({ |
| 220 | previousId: olds?.instructionId ?? output?.instructionId, |
| 221 | nextId: news.instructionId, |
| 222 | extra, |
| 223 | }); |
| 224 | }), |
| 225 | |
| 226 | read: Effect.fn(function* ({ id, olds, output }) { |
| 227 | const env = yield* GcpEnvironment.current; |
| 228 | const instructionId = |
| 229 | olds?.instructionId ?? |
| 230 | output?.instructionId ?? |
| 231 | (output?.name ? parseResourceName(output.name, "instructions").id : ""); |
| 232 | const name = |
| 233 | output?.name ?? (instructionId.length > 0 ? resourceName(env.project, instructionId) : ""); |
| 234 | const existing = (yield* getByName(name)) ?? (yield* findByOwnership(id, env.project)); |
| 235 | if (existing === undefined) return undefined; |
| 236 | const attrs = toAttrs(existing, env.project); |
| 237 | return (yield* ownedByAlchemy(id, existing.description)) ? attrs : Unowned(attrs); |
| 238 | }), |
| 239 | |
| 240 | list: () => |
| 241 | Effect.gen(function* () { |
| 242 | const env = yield* GcpEnvironment.current; |
| 243 | const rows = yield* listInstructions(projectParent(env.project)); |
| 244 | return rows |
| 245 | .filter((row) => hasOwnershipMarker(row.description)) |
| 246 | .map((row) => toAttrs(row, env.project)); |
| 247 | }), |
| 248 | |
| 249 | reconcile: Effect.fn(function* ({ id, news, output }) { |
| 250 | const env = yield* GcpEnvironment.current; |
| 251 | const instructionId = news.instructionId ?? output?.instructionId; |
| 252 | const name = |
| 253 | output?.name ?? |
| 254 | (instructionId !== undefined ? resourceName(env.project, instructionId) : ""); |
| 255 | const ownership = yield* createInternalLabels(id); |
| 256 | const displayName = yield* toDisplayName(id, news.displayName, output?.displayName); |
| 257 | const description = encodeOwnership(ownership, news.description); |
| 258 | |
| 259 | let current = (yield* getByName(name)) ?? (yield* findByOwnership(id, env.project)); |
| 260 | |
| 261 | if (current === undefined) { |
| 262 | const created = yield* retryTransient( |
| 263 | datalabeling.createProjectsInstructions({ |
| 264 | parent: projectParent(env.project), |
| 265 | body: { |
| 266 | instruction: { |
| 267 | displayName, |
| 268 | description, |
| 269 | dataType: news.dataType, |
| 270 | pdfInstruction: news.pdfInstruction, |
| 271 | csvInstruction: news.csvInstruction, |
| 272 | }, |
| 273 | }, |
| 274 | }), |
| 275 | ).pipe(Effect.catchTag("Conflict", () => Effect.undefined)); |
| 276 | if (created !== undefined) { |
| 277 | const done = yield* waitForOperation(created); |
| 278 | const createdName = resourceNameFromOperation(done); |
| 279 | if (createdName !== undefined) { |
| 280 | current = yield* waitForVisible(getByName(createdName)); |
| 281 | } |
| 282 | } |
| 283 | if (current === undefined) { |
| 284 | current = yield* findByOwnership(id, env.project); |
| 285 | } |
| 286 | } |
| 287 | |
| 288 | if (current === undefined) { |
| 289 | return yield* new InstructionNotResolved({ |
| 290 | resourceName: name || projectParent(env.project), |
| 291 | }); |
| 292 | } |
| 293 | |
| 294 | return toAttrs(current, env.project); |
| 295 | }), |
| 296 | |
| 297 | delete: Effect.fn(function* ({ output }) { |
| 298 | if (!output.name) return; |
| 299 | yield* datalabeling |
| 300 | .deleteProjectsInstructions({ name: output.name }) |
| 301 | .pipe(retryDelete, ignoreGone); |
| 302 | yield* waitUntilGone(getByName(output.name)); |
| 303 | }), |
| 304 | }); |