@ucdjs/pipelines-artifacts 0.0.1-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-PRESENT Lucas Nørgård
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,27 @@
+# @ucdjs/pipelines-artifacts
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![codecov][codecov-src]][codecov-href]
+
+> [!IMPORTANT]
+> This is an internal package. It may change without warning and is not subject to semantic versioning. Use at your own risk.
+
+A collection of core pipeline functionalities for the UCD project.
+
+## Installation
+
+```bash
+npm install @ucdjs/pipelines-artifacts
+```
+
+## 📄 License
+
+Published under [MIT License](./LICENSE).
+
+[npm-version-src]: https://img.shields.io/npm/v/@ucdjs/pipelines-artifacts?style=flat&colorA=18181B&colorB=4169E1
+[npm-version-href]: https://npmjs.com/package/@ucdjs/pipelines-artifacts
+[npm-downloads-src]: https://img.shields.io/npm/dm/@ucdjs/pipelines-artifacts?style=flat&colorA=18181B&colorB=4169E1
+[npm-downloads-href]: https://npmjs.com/package/@ucdjs/pipelines-artifacts
+[codecov-src]: https://img.shields.io/codecov/c/gh/ucdjs/ucd?style=flat&colorA=18181B&colorB=4169E1
+[codecov-href]: https://codecov.io/gh/ucdjs/ucd

package/dist/index.d.mts

@@ -0,0 +1,40 @@
+import { ParseContext, ParsedRow, PipelineFilter } from "@ucdjs/pipelines-core";
+import { z } from "zod";
+
+//#region src/definition.d.ts
+interface ArtifactBuildContext {
+  version: string;
+}
+interface PipelineArtifactDefinition<TId extends string = string, TValue = unknown> {
+  id: TId;
+  filter?: PipelineFilter;
+  parser?: (ctx: ParseContext) => AsyncIterable<ParsedRow>;
+  build: (ctx: ArtifactBuildContext, rows?: AsyncIterable<ParsedRow>) => Promise<TValue>;
+}
+declare function definePipelineArtifact<const TId extends string, TValue>(definition: PipelineArtifactDefinition<TId, TValue>): PipelineArtifactDefinition<TId, TValue>;
+type InferArtifactId<T> = T extends PipelineArtifactDefinition<infer TId, unknown> ? TId : never;
+type InferArtifactValue<T> = T extends PipelineArtifactDefinition<string, infer TValue> ? TValue : never;
+type InferArtifactsMap<T extends readonly PipelineArtifactDefinition[]> = { [K in T[number] as InferArtifactId<K>]: InferArtifactValue<K> };
+declare function isPipelineArtifactDefinition(value: unknown): value is PipelineArtifactDefinition;
+//#endregion
+//#region src/schema.d.ts
+interface Artifact<TSchema extends z.ZodType = z.ZodType> {
+  _type: "artifact";
+  schema: TSchema;
+  scope: "version";
+}
+interface GlobalArtifact<TSchema extends z.ZodType = z.ZodType> {
+  _type: "global-artifact";
+  schema: TSchema;
+  scope: "global";
+}
+type ArtifactDefinition<TSchema extends z.ZodType = z.ZodType> = Artifact<TSchema> | GlobalArtifact<TSchema>;
+declare function artifact<TSchema extends z.ZodType>(schema: TSchema): Artifact<TSchema>;
+declare function artifact<TSchema extends z.ZodType>(schema: TSchema, scope: "version"): Artifact<TSchema>;
+declare function artifact<TSchema extends z.ZodType>(schema: TSchema, scope: "global"): GlobalArtifact<TSchema>;
+type InferArtifactSchemaType<T extends ArtifactDefinition> = T extends ArtifactDefinition<infer TSchema> ? z.infer<TSchema> : never;
+type InferEmittedArtifacts<TEmits extends Record<string, ArtifactDefinition>> = { [K in keyof TEmits]: InferArtifactSchemaType<TEmits[K]> };
+declare function isGlobalArtifact<TSchema extends z.ZodType>(def: ArtifactDefinition<TSchema>): def is GlobalArtifact<TSchema>;
+declare function isVersionArtifact<TSchema extends z.ZodType>(def: ArtifactDefinition<TSchema>): def is Artifact<TSchema>;
+//#endregion
+export { type Artifact, type ArtifactBuildContext, type ArtifactDefinition, type GlobalArtifact, type InferArtifactId, type InferArtifactSchemaType, type InferArtifactValue, type InferArtifactsMap, type InferEmittedArtifacts, type PipelineArtifactDefinition, artifact, definePipelineArtifact, isGlobalArtifact, isPipelineArtifactDefinition, isVersionArtifact };

package/dist/index.mjs

@@ -0,0 +1,31 @@
+//#region src/definition.ts
+function definePipelineArtifact(definition) {
+	return definition;
+}
+function isPipelineArtifactDefinition(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value) && "id" in value && "build" in value && typeof value.id === "string" && typeof value.build === "function" && (!("filter" in value) || typeof value.filter === "function") && (!("parser" in value) || typeof value.parser === "function");
+}
+
+//#endregion
+//#region src/schema.ts
+function artifact(schema, scope) {
+	if (scope === "global") return {
+		_type: "global-artifact",
+		schema,
+		scope: "global"
+	};
+	return {
+		_type: "artifact",
+		schema,
+		scope: "version"
+	};
+}
+function isGlobalArtifact(def) {
+	return def._type === "global-artifact";
+}
+function isVersionArtifact(def) {
+	return def._type === "artifact";
+}
+
+//#endregion
+export { artifact, definePipelineArtifact, isGlobalArtifact, isPipelineArtifactDefinition, isVersionArtifact };

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@ucdjs/pipelines-artifacts",
+  "version": "0.0.1-beta.1",
+  "type": "module",
+  "author": {
+    "name": "Lucas Nørgård",
+    "email": "lucasnrgaard@gmail.com",
+    "url": "https://luxass.dev"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/ucdjs/ucd",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ucdjs/ucd.git",
+    "directory": "packages/pipelines/pipeline-artifacts"
+  },
+  "bugs": {
+    "url": "https://github.com/ucdjs/ucd/issues"
+  },
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22.18"
+  },
+  "dependencies": {
+    "zod": "4.3.6",
+    "@ucdjs/pipelines-core": "0.0.1-beta.1"
+  },
+  "devDependencies": {
+    "@luxass/eslint-config": "7.2.0",
+    "eslint": "10.0.0",
+    "publint": "0.3.17",
+    "tsdown": "0.20.3",
+    "typescript": "5.9.3",
+    "@ucdjs-tooling/tsconfig": "1.0.0",
+    "@ucdjs-tooling/tsdown-config": "1.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown --tsconfig=./tsconfig.build.json",
+    "dev": "tsdown --watch",
+    "clean": "git clean -xdf dist node_modules",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit -p tsconfig.build.json"
+  }
+}