@ankhorage/repository 0.4.18 → 0.5.0

package/dist/providers/github/services/materializeGitHubRepositoryWithGatewayAsync.test.js

@@ -0,0 +1,116 @@
+import { access, readFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import { expect, test } from 'bun:test';
+import { materializeGitHubRepositoryWithGatewayAsync } from './materializeGitHubRepositoryWithGatewayAsync.js';
+test('materializes an exact GitHub revision and cleans up the isolated root', async () => {
+    const requestedRefs = [];
+    const gateway = createGateway({
+        requestedRefs,
+        files: {
+            'package.json': '{"name":"demo"}\n',
+            'src/index.ts': 'export const demo = true;\n',
+        },
+    });
+    const result = await materializeGitHubRepositoryWithGatewayAsync({ url: 'https://github.com/ankhorage/demo', ref: 'feature/read' }, gateway);
+    expect(requestedRefs).toEqual(['feature/read']);
+    expect(result.revision).toBe('commit-sha');
+    expect(result.repository).toEqual({
+        owner: 'ankhorage',
+        name: 'demo',
+        url: 'https://github.com/ankhorage/demo',
+        defaultBranch: 'main',
+    });
+    expect(await readFile(join(result.rootPath, 'src/index.ts'), 'utf8')).toBe('export const demo = true;\n');
+    await result.cleanupAsync();
+    await expectMissingPathAsync(result.rootPath);
+});
+test('uses the remote default branch when no ref is supplied', async () => {
+    const requestedRefs = [];
+    const result = await materializeGitHubRepositoryWithGatewayAsync({ url: 'https://github.com/ankhorage/demo.git' }, createGateway({ requestedRefs, defaultBranch: 'develop', files: {} }));
+    expect(requestedRefs).toEqual(['develop']);
+    await result.cleanupAsync();
+});
+test('rejects traversal before downloading an unsafe repository file', async () => {
+    let reads = 0;
+    const gateway = createGateway({
+        files: { '../escape.ts': 'escape' },
+        onRead: () => {
+            reads += 1;
+        },
+    });
+    await expectFailureAsync(() => materializeGitHubRepositoryWithGatewayAsync({ url: 'https://github.com/ankhorage/demo' }, gateway), 'Unsafe GitHub repository path');
+    expect(reads).toBe(0);
+});
+test('rejects truncated GitHub trees before materialization', async () => {
+    const gateway = createGateway({ files: {}, truncated: true });
+    await expectFailureAsync(() => materializeGitHubRepositoryWithGatewayAsync({ url: 'https://github.com/ankhorage/demo' }, gateway), 'repository tree is truncated');
+});
+test('rejects unsafe symbolic links rather than following provider paths', async () => {
+    const gateway = {
+        ...createGateway({ files: {} }),
+        readTreeAsync: () => Promise.resolve({
+            truncated: false,
+            entries: [
+                {
+                    mode: '120000',
+                    path: 'outside',
+                    sha: 'link-sha',
+                    size: 10,
+                    type: 'blob',
+                },
+            ],
+        }),
+    };
+    await expectFailureAsync(() => materializeGitHubRepositoryWithGatewayAsync({ url: 'https://github.com/ankhorage/demo' }, gateway), 'symbolic links are not supported');
+});
+function createGateway(options) {
+    const files = new Map(Object.entries(options.files));
+    const entries = [...files].map(([path, fileContent], index) => ({
+        mode: '100644',
+        path,
+        sha: `blob-${index}`,
+        size: Buffer.byteLength(fileContent),
+        type: 'blob',
+    }));
+    return {
+        inspectRepositoryAsync: (target) => Promise.resolve({
+            defaultBranch: options.defaultBranch ?? 'main',
+            url: target.url,
+        }),
+        resolveRevisionAsync: (_target, ref) => {
+            options.requestedRefs?.push(ref);
+            return Promise.resolve({ commitSha: 'commit-sha', treeSha: 'tree-sha' });
+        },
+        readTreeAsync: () => Promise.resolve({
+            entries,
+            truncated: options.truncated ?? false,
+        }),
+        readFileAsync: (_target, _revision, path) => {
+            options.onRead?.();
+            const fileContent = files.get(path);
+            if (fileContent === undefined)
+                throw new Error(`Missing fixture: ${path}`);
+            return Promise.resolve(Buffer.from(fileContent));
+        },
+    };
+}
+async function expectFailureAsync(operation, message) {
+    try {
+        await operation();
+        throw new Error('Expected operation to fail.');
+    }
+    catch (error) {
+        expect(error).toBeInstanceOf(Error);
+        expect(error.message).toContain(message);
+    }
+}
+async function expectMissingPathAsync(path) {
+    try {
+        await access(path);
+        throw new Error('Expected path to be missing.');
+    }
+    catch (error) {
+        expect(error).toBeInstanceOf(Error);
+    }
+}
+//# sourceMappingURL=materializeGitHubRepositoryWithGatewayAsync.test.js.map

package/dist/providers/github/services/materializeGitHubRepositoryWithGatewayAsync.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"materializeGitHubRepositoryWithGatewayAsync.test.js","sourceRoot":"","sources":["../../../../src/providers/github/services/materializeGitHubRepositoryWithGatewayAsync.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAGxC,OAAO,EAAE,2CAA2C,EAAE,MAAM,kDAAkD,CAAC;AAE/G,IAAI,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;IACvF,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,MAAM,OAAO,GAAG,aAAa,CAAC;QAC5B,aAAa;QACb,KAAK,EAAE;YACL,cAAc,EAAE,mBAAmB;YACnC,cAAc,EAAE,6BAA6B;SAC9C;KACF,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,2CAA2C,CAC9D,EAAE,GAAG,EAAE,mCAAmC,EAAE,GAAG,EAAE,cAAc,EAAE,EACjE,OAAO,CACR,CAAC;IAEF,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;IAChD,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3C,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC;QAChC,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,mCAAmC;QACxC,aAAa,EAAE,MAAM;KACtB,CAAC,CAAC;IACH,MAAM,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CACxE,6BAA6B,CAC9B,CAAC;IAEF,MAAM,MAAM,CAAC,YAAY,EAAE,CAAC;IAC5B,MAAM,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAChD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;IACxE,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,MAAM,2CAA2C,CAC9D,EAAE,GAAG,EAAE,uCAAuC,EAAE,EAChD,aAAa,CAAC,EAAE,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CACtE,CAAC;IAEF,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3C,MAAM,MAAM,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;IAChF,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,MAAM,OAAO,GAAG,aAAa,CAAC;QAC5B,KAAK,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE;QACnC,MAAM,EAAE,GAAG,EAAE;YACX,KAAK,IAAI,CAAC,CAAC;QACb,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,kBAAkB,CACtB,GAAG,EAAE,CACH,2CAA2C,CACzC,EAAE,GAAG,EAAE,mCAAmC,EAAE,EAC5C,OAAO,CACR,EACH,+BAA+B,CAChC,CAAC;IACF,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;IACvE,MAAM,OAAO,GAAG,aAAa,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE9D,MAAM,kBAAkB,CACtB,GAAG,EAAE,CACH,2CAA2C,CACzC,EAAE,GAAG,EAAE,mCAAmC,EAAE,EAC5C,OAAO,CACR,EACH,8BAA8B,CAC/B,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;IACpF,MAAM,OAAO,GAAgC;QAC3C,GAAG,aAAa,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QAC/B,aAAa,EAAE,GAAG,EAAE,CAClB,OAAO,CAAC,OAAO,CAAC;YACd,SAAS,EAAE,KAAK;YAChB,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,SAAS;oBACf,GAAG,EAAE,UAAU;oBACf,IAAI,EAAE,EAAE;oBACR,IAAI,EAAE,MAAM;iBACb;aACF;SACF,CAAC;KACL,CAAC;IAEF,MAAM,kBAAkB,CACtB,GAAG,EAAE,CACH,2CAA2C,CACzC,EAAE,GAAG,EAAE,mCAAmC,EAAE,EAC5C,OAAO,CACR,EACH,kCAAkC,CACnC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,SAAS,aAAa,CAAC,OAMtB;IACC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC9D,IAAI,EAAE,QAAQ;QACd,IAAI;QACJ,GAAG,EAAE,QAAQ,KAAK,EAAE;QACpB,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC;QACpC,IAAI,EAAE,MAAe;KACtB,CAAC,CAAC,CAAC;IACJ,OAAO;QACL,sBAAsB,EAAE,CAAC,MAAM,EAAE,EAAE,CACjC,OAAO,CAAC,OAAO,CAAC;YACd,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,MAAM;YAC9C,GAAG,EAAE,MAAM,CAAC,GAAG;SAChB,CAAC;QACJ,oBAAoB,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;YACrC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YACjC,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QAC3E,CAAC;QACD,aAAa,EAAE,GAAG,EAAE,CAClB,OAAO,CAAC,OAAO,CAAC;YACd,OAAO;YACP,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,KAAK;SACtC,CAAC;QACJ,aAAa,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;YAC1C,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YACnB,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,WAAW,KAAK,SAAS;gBAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,EAAE,CAAC,CAAC;YAC3E,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QACnD,CAAC;KACF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,SAAiC,EACjC,OAAe;IAEf,IAAI,CAAC;QACH,MAAM,SAAS,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QACpC,MAAM,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;AACH,CAAC;AAED,KAAK,UAAU,sBAAsB,CAAC,IAAY;IAChD,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankhorage/repository",
-  "version": "0.4.18",
+  "version": "0.5.0",
   "description": "Standalone repository capability for connecting and managing an app project's source repository.",
   "type": "module",
   "license": "MIT",
@@ -54,7 +54,8 @@
     "category": "repository",
     "provider": "./dist/cli/index.js",
     "capabilities": [
-      "repository.connect"
+      "repository.connect",
+      "repository.materialize"
     ]
   },
   "publishConfig": {
@@ -75,15 +76,15 @@
     "knip:check": "ankhorage-knip"
   },
   "devDependencies": {
-    "@ankhorage/devtools": "^1.18.5",
-    "@ankhorage/paradox": "^0.1.26",
-    "@types/bun": "^1.4.1",
-    "@types/node": "^24.13.3",
+    "@ankhorage/devtools": "^2.1.6",
+    "@ankhorage/paradox": "^0.2.27",
+    "@types/bun": "^1.4.2",
+    "@types/node": "^26.6.4",
     "typescript": "~6.0.3"
   },
   "packageManager": "bun@1.4.2",
   "dependencies": {
-    "@ankhorage/contracts": "^22.8.1",
-    "ignore": "^7.0.8"
+    "@ankhorage/contracts": "^22.8.99",
+    "ignore": "^7.0.12"
   }
 }

package/dist/readme-usage.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=readme-usage.d.ts.map

package/dist/readme-usage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"readme-usage.d.ts","sourceRoot":"","sources":["../src/readme-usage.ts"],"names":[],"mappings":""}

package/dist/readme-usage.js

@@ -1,32 +0,0 @@
-/***
- * Connect a project folder to its source repository
- *
- * `@ankhorage/repository` consumes only the project's `RepositoryManifest` slice and delegates
- * GitHub operations to the local authenticated `gh` adapter. It creates a missing repository,
- * publishes the project snapshot to `main`, stores only the repository slice in
- * `.ankhorage/repository.json`, and refuses unrelated existing repositories.
- *
- * See [`examples/basic-usage.ts`](../examples/basic-usage.ts) for a complete programmatic example.
- *
- * @usage
- */
-import { connectRepositoryAsync } from '@ankhorage/repository';
-const result = await connectRepositoryAsync({
-    projectPath: './my-project',
-    repository: {
-        provider: 'github',
-        owner: 'ankhorage',
-        name: 'my-project',
-        url: 'https://github.com/ankhorage/my-project',
-        defaultBranch: 'main',
-    },
-    visibility: 'private',
-});
-if (result.status === 'conflict' || result.status === 'recoverable-failure') {
-    console.error(`${result.status}: ${result.message}`);
-    process.exitCode = 1;
-}
-else {
-    console.log(JSON.stringify(result));
-}
-//# sourceMappingURL=readme-usage.js.map

package/dist/readme-usage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"readme-usage.js","sourceRoot":"","sources":["../src/readme-usage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,MAAM,MAAM,GAAG,MAAM,sBAAsB,CAAC;IAC1C,WAAW,EAAE,cAAc;IAC3B,UAAU,EAAE;QACV,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,YAAY;QAClB,GAAG,EAAE,yCAAyC;QAC9C,aAAa,EAAE,MAAM;KACtB;IACD,UAAU,EAAE,SAAS;CACtB,CAAC,CAAC;AAEH,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,IAAI,MAAM,CAAC,MAAM,KAAK,qBAAqB,EAAE,CAAC;IAC5E,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IACrD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC;KAAM,CAAC;IACN,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;AACtC,CAAC"}