@hatchet-dev/typescript-sdk 1.15.0 → 1.15.2

package/{src/v1 → v1}/types.d.ts

@@ -28,4 +28,4 @@ export type StrictWorkflowOutputType<T = any> = IsValidWorkflowOutput<T> extends
     [ERROR_WORKFLOW_OUTPUT]?: 'Workflow output must be shaped as Record<"task-name", JsonObject>. Each property must be an object, not a primitive value.';
 };
 declare const ERROR_WORKFLOW_OUTPUT: unique symbol;
-export type { TaskMiddleware as HatchetMiddleware } from '../../clients/hatchet-client/client-config';
+export type { TaskMiddleware as HatchetMiddleware } from '../clients/hatchet-client/client-config';

package/version.d.ts

@@ -0,0 +1 @@
+export declare const HATCHET_VERSION = "1.15.2";

package/{src/version.js → version.js}

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HATCHET_VERSION = void 0;
-exports.HATCHET_VERSION = '1.15.0';
+exports.HATCHET_VERSION = '1.15.2';

package/{src/workflow.d.ts → workflow.d.ts}

@@ -1,3 +1,3 @@
-import { ConcurrencyLimitStrategy, StickyStrategy } from '../v1';
+import { ConcurrencyLimitStrategy, StickyStrategy } from './v1';
 export * from './legacy/workflow';
 export { ConcurrencyLimitStrategy, StickyStrategy };

package/{src/workflow.js → workflow.js}

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StickyStrategy = exports.ConcurrencyLimitStrategy = void 0;
-const v1_1 = require("../v1");
+const v1_1 = require("./v1");
 Object.defineProperty(exports, "ConcurrencyLimitStrategy", { enumerable: true, get: function () { return v1_1.ConcurrencyLimitStrategy; } });
 Object.defineProperty(exports, "StickyStrategy", { enumerable: true, get: function () { return v1_1.StickyStrategy; } });
 __exportStar(require("./legacy/workflow"), exports);

package/docs/doc_types.d.ts

@@ -1,12 +0,0 @@
-export interface Document {
-    sourcePath: string;
-    readableSourcePath: string;
-    mdxOutputPath: string;
-    mdxOutputMetaJsPath: string;
-    isIndex: boolean;
-    directory: string;
-    basename: string;
-    title: string;
-    metaJsEntry: string;
-}
-export declare function documentFromPath(filePath: string): Document;

package/docs/doc_types.js

@@ -1,62 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.documentFromPath = documentFromPath;
-const path_1 = __importDefault(require("path"));
-const shared_1 = require("./shared");
-const FILENAME_REMAP = {
-    'Hatchet-TypeScript-SDK-Reference.mdx': 'client.mdx',
-};
-function remapFilename(filename) {
-    var _a;
-    const remapped = (_a = FILENAME_REMAP[filename]) !== null && _a !== void 0 ? _a : filename;
-    if (remapped.startsWith('client.features.')) {
-        const leafName = remapped.replace('client.features.', '');
-        return {
-            outRelative: 'feature-clients/' + leafName,
-            basename: path_1.default.basename(leafName, shared_1.MDX_EXTENSION),
-            directory: '/feature-clients',
-        };
-    }
-    return {
-        outRelative: remapped,
-        basename: path_1.default.basename(remapped, shared_1.MDX_EXTENSION),
-        directory: '',
-    };
-}
-function toTitle(basename) {
-    return basename
-        .replace(/[-_.]/g, ' ')
-        .replace(/[^0-9a-zA-Z ]+/g, '')
-        .trim()
-        .replace(/\s+/g, ' ')
-        .split(' ')
-        .map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
-        .join(' ');
-}
-function documentFromPath(filePath) {
-    const filename = path_1.default.basename(filePath);
-    const { outRelative, basename, directory } = remapFilename(filename);
-    const title = toTitle(basename);
-    const outFull = path_1.default.join(shared_1.FRONTEND_DOCS_RELATIVE_PATH, outRelative);
-    const outDir = path_1.default.dirname(outFull);
-    const metaJsEntry = `  "${basename}": {
-    title: "${title}",
-    theme: {
-      toc: true,
-    },
-  },`;
-    return {
-        directory,
-        basename,
-        title,
-        metaJsEntry,
-        sourcePath: filePath,
-        readableSourcePath: filename,
-        mdxOutputPath: outFull,
-        mdxOutputMetaJsPath: path_1.default.join(outDir, '_meta.js'),
-        isIndex: basename === 'index' || basename === 'README',
-    };
-}

package/docs/generate.d.ts

@@ -1 +0,0 @@
-export {};

package/docs/generate.js

@@ -1,87 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const child_process_1 = require("child_process");
-const paths_1 = require("./paths");
-const shared_1 = require("./shared");
-function rmrf(target) {
-    if (fs_1.default.existsSync(target)) {
-        fs_1.default.rmSync(target, { recursive: true, force: true });
-    }
-}
-function metaEntry(key, title) {
-    return `  "${key}": {
-    title: "${title}",
-    theme: {
-      toc: true,
-    },
-  },`;
-}
-function generateMetaJs(docs, subDirs) {
-    const docEntries = docs.map((d) => d.metaJsEntry);
-    const subDirEntries = subDirs.map((dir) => {
-        const name = dir.replace(/^\//, '');
-        const title = name.replace(/-/g, ' ').replace(/\b\w/g, (c) => c.toUpperCase());
-        return metaEntry(name, title);
-    });
-    const all = [...docEntries, ...subDirEntries].sort((a, b) => {
-        const keyA = a.trim().split(':')[0].replace(/"/g, '').toLowerCase();
-        const keyB = b.trim().split(':')[0].replace(/"/g, '').toLowerCase();
-        return keyA.localeCompare(keyB);
-    });
-    return `export default {\n${all.join('\n\n')}\n};\n`;
-}
-function updateMetaJs(documents) {
-    const metaJsPaths = new Set(documents.map((d) => d.mdxOutputMetaJsPath));
-    for (const metaJsPath of metaJsPaths) {
-        const relevantDocs = documents.filter((d) => d.mdxOutputMetaJsPath === metaJsPath);
-        const thisDir = relevantDocs[0].directory;
-        const subDirs = [
-            ...new Set(documents
-                .map((d) => d.directory)
-                .filter((dir) => dir !== thisDir && dir.startsWith(thisDir) && dir.split('/').length === thisDir.split('/').filter(Boolean).length + 2)),
-        ];
-        const meta = generateMetaJs(relevantDocs, subDirs);
-        fs_1.default.mkdirSync(path_1.default.dirname(metaJsPath), { recursive: true });
-        fs_1.default.writeFileSync(metaJsPath, meta, 'utf-8');
-        console.log('Wrote', metaJsPath);
-    }
-}
-function fixBrokenFeatureAnchorLinks(content) {
-    return content.replace(/\(client\.features\.([^)\s#]+\.mdx)/g, '(feature-clients/$1');
-}
-function copyDoc(document) {
-    const content = fixBrokenFeatureAnchorLinks(fs_1.default.readFileSync(document.sourcePath, 'utf-8'));
-    fs_1.default.mkdirSync(path_1.default.dirname(document.mdxOutputPath), { recursive: true });
-    fs_1.default.writeFileSync(document.mdxOutputPath, content, 'utf-8');
-    console.log('Wrote', document.mdxOutputPath);
-}
-function run() {
-    rmrf(shared_1.TMP_GEN_PATH);
-    try {
-        console.log('Running typedoc...');
-        (0, child_process_1.execSync)('npx typedoc', { stdio: 'inherit' });
-        const documents = (0, paths_1.crawlDirectory)(shared_1.TMP_GEN_PATH);
-        console.log(`Found ${documents.length} documents`);
-        for (const doc of documents) {
-            copyDoc(doc);
-        }
-        updateMetaJs(documents);
-        console.log('Running prettier on frontend docs...');
-        (0, child_process_1.execSync)('pnpm lint:fix', {
-            stdio: 'inherit',
-            cwd: path_1.default.resolve(process.cwd(), '../../frontend/docs'),
-            shell: '/bin/bash',
-        });
-    }
-    finally {
-        rmrf(shared_1.TMP_GEN_PATH);
-    }
-}
-if (require.main === module) {
-    run();
-}

package/docs/paths.d.ts

@@ -1,2 +0,0 @@
-import { Document } from './doc_types';
-export declare function crawlDirectory(directory: string, onlyInclude?: string[]): Document[];

package/docs/paths.js

@@ -1,16 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.crawlDirectory = crawlDirectory;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const doc_types_1 = require("./doc_types");
-function crawlDirectory(directory, onlyInclude = []) {
-    return fs_1.default
-        .readdirSync(directory, { withFileTypes: true })
-        .filter((entry) => entry.isFile() && entry.name.endsWith('.mdx') && entry.name !== 'README.mdx')
-        .map((entry) => (0, doc_types_1.documentFromPath)(path_1.default.join(directory, entry.name)))
-        .filter((doc) => !onlyInclude.length || onlyInclude.includes(doc.readableSourcePath));
-}

package/docs/shared.d.ts

@@ -1,3 +0,0 @@
-export declare const TMP_GEN_PATH = "/tmp/hatchet-typescript/docs/gen";
-export declare const FRONTEND_DOCS_RELATIVE_PATH = "../../frontend/docs/pages/sdks/typescript";
-export declare const MDX_EXTENSION = ".mdx";

package/docs/shared.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MDX_EXTENSION = exports.FRONTEND_DOCS_RELATIVE_PATH = exports.TMP_GEN_PATH = void 0;
-exports.TMP_GEN_PATH = '/tmp/hatchet-typescript/docs/gen';
-exports.FRONTEND_DOCS_RELATIVE_PATH = '../../frontend/docs/pages/sdks/typescript';
-exports.MDX_EXTENSION = '.mdx';

package/src/clients/hatchet-client/index.d.ts

@@ -1,3 +0,0 @@
-export * from '../../legacy/legacy-client';
-export * from './client-config';
-export { HatchetLogger } from '../../../clients/hatchet-client/hatchet-logger';

package/src/sdk.d.ts

@@ -1,2 +0,0 @@
-import { HatchetClient as Hatchet } from '../v1/client/client';
-export default Hatchet;

package/src/v1/conditions/transformer.d.ts

@@ -1,5 +0,0 @@
-import { TaskConditions } from '../../../protoc/v1/shared/condition';
-import { CreateWorkflowTaskOpts } from '../task';
-import { Condition } from './base';
-export declare function taskConditionsToPb(task: Omit<CreateWorkflowTaskOpts<any, any>, 'fn'>): TaskConditions;
-export declare function conditionsToPb(conditions: Condition[]): TaskConditions;

package/src/v1/examples/concurrency_limit_rr/workflow.d.ts

@@ -1,12 +0,0 @@
-type SimpleInput = {
-    Message: string;
-    GroupKey: string;
-};
-type SimpleOutput = {
-    'to-lower': {
-        TransformedMessage: string;
-    };
-};
-export declare const simpleConcurrency: import("../../../../v1").WorkflowDeclaration<SimpleInput, SimpleOutput, {}>;
-export declare const multipleConcurrencyKeys: import("../../../../v1").WorkflowDeclaration<SimpleInput, SimpleOutput, {}>;
-export {};

package/src/v1/examples/legacy/workflow.d.ts

@@ -1,2 +0,0 @@
-import { Workflow } from '../../../../workflow';
-export declare const simple: Workflow;

package/src/v1/examples/logger/workflow.d.ts

@@ -1,2 +0,0 @@
-import type { HatchetClient } from '../../../../v1';
-export declare function createLoggingWorkflow(client: HatchetClient): import("../../../../v1").WorkflowDeclaration<import("../../../../v1").UnknownInputType, {}, {}>;

package/src/v1/examples/priority/workflow.d.ts

@@ -1,8 +0,0 @@
-import { Priority } from '../../../../v1';
-export declare const priority: import("../../../../v1").TaskWorkflowDeclaration<import("../../../../v1").UnknownInputType, {
-    priority: Priority | undefined;
-}, {}, {}, {}, {}>;
-export declare const priorityWf: import("../../../../v1").WorkflowDeclaration<import("../../../../v1").UnknownInputType, {}, {}>;
-export declare const priorityTasks: (import("../../../../v1").WorkflowDeclaration<import("../../../../v1").UnknownInputType, {}, {}> | import("../../../../v1").TaskWorkflowDeclaration<import("../../../../v1").UnknownInputType, {
-    priority: Priority | undefined;
-}, {}, {}, {}, {}>)[];

package/src/v1/examples/simple/e2e-workflows.d.ts

@@ -1,14 +0,0 @@
-export declare const helloWorld: import("../../../../v1").TaskWorkflowDeclaration<{
-    [x: string]: import("../../../../v1").JsonValue;
-} & {
-    [x: string]: import("../../../../v1").JsonValue;
-}, {
-    result: string;
-}, {}, {}, {}, {}>;
-export declare const helloWorldDurable: import("../../../../v1").TaskWorkflowDeclaration<{
-    [x: string]: import("../../../../v1").JsonValue;
-} & {
-    [x: string]: import("../../../../v1").JsonValue;
-}, {
-    result: string;
-}, {}, {}, {}, {}>;

package/src/v1/examples/sticky/workflow.d.ts

@@ -1,5 +0,0 @@
-export declare const sticky: import("../../../../v1").TaskWorkflowDeclaration<import("../../../../v1").UnknownInputType, {
-    result: {
-        Value: number;
-    };
-}, {}, {}, {}, {}>;

package/src/version.d.ts

@@ -1 +0,0 @@
-export declare const HATCHET_VERSION = "1.15.0";