SeedReference.location --> packet

Part of #3.

README.md

@@ -16,9 +16,9 @@ Run `garden`. You can pick a non-default seed to grow by running `garden --seed
 ### Seed Types
 
 All parameters can accept a literal value or a reference to another seed's
-result (`{location: 'seed_packet_file.json', id: 'REFERENCE_ID'}`), unless otherwise noted.
+result (`{packet: 'seed_packet_file.json', id: 'REFERENCE_ID'}`), unless otherwise noted.
 
-The location can be any of:
+The packet can be any of:
 - An absolute https:// or http:// file
 - A filepath relative to where the command is run from (in non-browser mode)
 - A relative path to the original (e.g. '../b/file.json')

seed-schema.json

@@ -25,7 +25,7 @@
 									{
 										"type": "object",
 										"properties": {
-											"location": {
+											"packet": {
 												"anyOf": [
 													{
 														"anyOf": [

seeds/default.json

@@ -20,7 +20,7 @@
         "remote-example": {
             "type": "log",
             "value": {
-                "location": "https://raw.githubusercontent.com/jkomoros/prompt-garden/main/seeds/default.json",
+                "packet": "https://raw.githubusercontent.com/jkomoros/prompt-garden/main/seeds/default.json",
                 "id": "hello-world"
             }
         }

src/garden.ts

@@ -55,14 +55,14 @@ export class Garden {
 	async seed(ref : SeedID | SeedReference = '') : Promise<Seed> {
 		if (typeof ref == 'string') {
 			ref = {
-				location: this.location || '',
+				packet: this.location || '',
 				id: ref
 			};
 		}
 		const absoluteRef = makeAbsolute(ref, this.location || '');
 		//This will return early if it already is fetched
-		await this.ensureSeedPacket(absoluteRef.location);
-		const collection = this._seeds[absoluteRef.location];
+		await this.ensureSeedPacket(absoluteRef.packet);
+		const collection = this._seeds[absoluteRef.packet];
 		if (!collection) throw new Error('Unexpectedly no packet');
 		const seed = collection[ref.id];
 		if (!seed) throw new Error(`No seed with ID ${seedReferenceToString(ref)}`);
@@ -105,10 +105,10 @@ export class Garden {
 	}
 
 	plantSeed(ref : AbsoluteSeedReference, data : SeedData) {
-		if (this._seeds[ref.location] == undefined) {
-			this._seeds[ref.location] = {};
+		if (this._seeds[ref.packet] == undefined) {
+			this._seeds[ref.packet] = {};
 		}
-		this._seeds[ref.location][ref.id] = new Seed(this, ref, data);
+		this._seeds[ref.packet][ref.id] = new Seed(this, ref, data);
 	}
 
 	plantSeedPacket(location: SeedPacketAbsoluteLocation, packet: SeedPacket) {
@@ -117,7 +117,7 @@ export class Garden {
 		if (!this._location) this._location = location;
 		for (const [id, seed] of Object.entries(packet.seeds)) {
 			const ref : AbsoluteSeedReference = {
-				location,
+				packet: location,
 				id
 			};
 			this.plantSeed(ref, seed);

src/reference.ts

@@ -13,7 +13,7 @@ export const isLocalLocation = (location : SeedPacketAbsoluteLocation) : boolean
 };
 
 export const seedReferenceToString = (ref : SeedReference) : string => {
-	let result = ref.location || '';
+	let result = ref.packet || '';
 	result += '#';
 	result += ref.id;
 	return result;
@@ -24,24 +24,24 @@ export const isRelativeSeedPacketLocation = (location : SeedPacketLocation) : lo
 };
 
 export const makeAbsolute = (ref : SeedReference, base : SeedPacketAbsoluteLocation) : AbsoluteSeedReference => {
-	const location = ref.location || '';
+	const location = ref.packet || '';
 	if (!isRelativeSeedPacketLocation(location)) {
 		return {
-			location: location || base,
+			packet: location || base,
 			id: ref.id
 		};
 	}
 	if (isLocalLocation(base)) {
 		const url = new URL(location, 'file://localhost/' + base);
 		return {
 			//TODO: this slices off the '/' assuming the base is a relative path from the current working directory.
-			location: url.pathname.slice(1),
+			packet: url.pathname.slice(1),
 			id: ref.id
 		};
 	}
 	const url = new URL(location, base);
 	return {
-		location: url.toString(),
+		packet: url.toString(),
 		id: ref.id
 	};
 };

src/seed.ts

@@ -41,7 +41,7 @@ export class Seed<D extends SeedData = SeedData> {
 	}
 
 	get location() : SeedPacketAbsoluteLocation {
-		return this._ref.location;
+		return this._ref.packet;
 	}
 
 	get type() : SeedDataType {

src/types.ts

@@ -101,14 +101,14 @@ export const seedPacketLocation = z.union([
 export type SeedPacketLocation = z.infer<typeof seedPacketLocation>;
 
 export const seedReference = z.object({
-	location: z.optional(seedPacketLocation),
+	packet: z.optional(seedPacketLocation),
 	id: seedID
 });
 
 export type SeedReference = z.infer<typeof seedReference>;
 
 export const requiredSeedReference = z.object({
-	location: seedPacketAbsoluteLocation,
+	packet: seedPacketAbsoluteLocation,
 	id: seedID
 });
 

test/base/b_test.json

@@ -8,7 +8,7 @@
         "remote-ref": {
             "type": "log",
             "value": {
-                "location": "./a_test.json",
+                "packet": "./a_test.json",
                 "id": "true"
             }
         }

test/base/test.ts

@@ -134,7 +134,7 @@ describe('Garden smoke test', () => {
 
 	it('handles a seed from another file', async() => {
 		const garden = loadTestGarden();
-		const seed = await garden.seed({location: 'test/base/b_test.json', id: ''});
+		const seed = await garden.seed({packet: 'test/base/b_test.json', id: ''});
 		const result = await seed.grow();
 		const golden = 'test-other hello world';
 		assert.deepStrictEqual(result, golden);
@@ -151,7 +151,7 @@ describe('Garden smoke test', () => {
 	it('handles growing a seed that references a seed in another file', async () => {
 		//Garden will have both files loaded up, so it won't need to be fetched.
 		const garden = loadTestGarden();
-		const seed = await garden.seed({location: 'test/base/b_test.json', id: 'remote-ref'});
+		const seed = await garden.seed({packet: 'test/base/b_test.json', id: 'remote-ref'});
 		const result = await seed.grow();
 		const golden = true;
 		assert.deepStrictEqual(result, golden);
@@ -160,7 +160,7 @@ describe('Garden smoke test', () => {
 	it('handles growing a seed that references a seed in another file', async () => {
 		//Garden will have both files loaded up, so it won't need to be fetched.
 		const garden = loadTestGarden();
-		const seed = await garden.seed({location: 'test/base/b_test.json', id: 'remote-ref'});
+		const seed = await garden.seed({packet: 'test/base/b_test.json', id: 'remote-ref'});
 		const result = await seed.grow();
 		const golden = true;
 		assert.deepStrictEqual(result, golden);
@@ -169,7 +169,7 @@ describe('Garden smoke test', () => {
 	it('handles growing a seed that references a seed in another file that isn\'t loaded yet', async () => {
 		//Force garden to have only the first file loaded.
 		const garden = loadTestGarden(['test/base/b_test.json']);
-		const seed = await garden.seed({location: 'test/base/b_test.json', id: 'remote-ref'});
+		const seed = await garden.seed({packet: 'test/base/b_test.json', id: 'remote-ref'});
 		const result = await seed.grow();
 		const golden = true;
 		assert.deepStrictEqual(result, golden);
@@ -178,7 +178,7 @@ describe('Garden smoke test', () => {
 	it('handles growing a seed that references a seed in another file that isn\'t loaded yet with no files loaded yet', async () => {
 		//Force garden to have no files loaded to start
 		const garden = loadTestGarden([]);
-		const seed = await garden.seed({location: 'test/base/b_test.json', id: 'remote-ref'});
+		const seed = await garden.seed({packet: 'test/base/b_test.json', id: 'remote-ref'});
 		const result = await seed.grow();
 		const golden = true;
 		assert.deepStrictEqual(result, golden);
@@ -188,7 +188,7 @@ describe('Garden smoke test', () => {
 		//Create an empty garden with no fetch
 		const garden = loadTestGarden([], true);
 		try {
-			await garden.seed({location: 'test/base/b_test.json', id: 'remote-ref'});
+			await garden.seed({packet: 'test/base/b_test.json', id: 'remote-ref'});
 		} catch(err) {
 			//Err expected
 			return;
@@ -261,7 +261,7 @@ describe('makeAbsolute', () => {
 	it('absolute is no op', async() => {
 		const base = 'd/e.json';
 		const input : AbsoluteSeedReference = {
-			location: 'a/b/c.json',
+			packet: 'a/b/c.json',
 			id: 'foo'
 		};
 		const result = makeAbsolute(input, base);
@@ -272,12 +272,12 @@ describe('makeAbsolute', () => {
 	it('relative works for local', async() => {
 		const base = 'a/b/c.json';
 		const input : SeedReference = {
-			location: '../c/e.json',
+			packet: '../c/e.json',
 			id: 'foo'
 		};
 		const result = makeAbsolute(input, base);
 		const golden : AbsoluteSeedReference = {
-			location: 'a/c/e.json',
+			packet: 'a/c/e.json',
 			id: 'foo'
 		};
 		assert.deepStrictEqual(result, golden);
@@ -286,12 +286,12 @@ describe('makeAbsolute', () => {
 	it('relative works for https', async() => {
 		const base = 'https://localhost/a/b/c.json';
 		const input : SeedReference = {
-			location: '../c/e.json',
+			packet: '../c/e.json',
 			id: 'foo'
 		};
 		const result = makeAbsolute(input, base);
 		const golden : AbsoluteSeedReference = {
-			location: 'https://localhost/a/c/e.json',
+			packet: 'https://localhost/a/c/e.json',
 			id: 'foo'
 		};
 		assert.deepStrictEqual(result, golden);
@@ -300,12 +300,12 @@ describe('makeAbsolute', () => {
 	it('relative with dot works for local', async() => {
 		const base = 'a/b/c.json';
 		const input : SeedReference = {
-			location: './f/e.json',
+			packet: './f/e.json',
 			id: 'foo'
 		};
 		const result = makeAbsolute(input, base);
 		const golden : AbsoluteSeedReference = {
-			location: 'a/b/f/e.json',
+			packet: 'a/b/f/e.json',
 			id: 'foo'
 		};
 		assert.deepStrictEqual(result, golden);
@@ -314,12 +314,12 @@ describe('makeAbsolute', () => {
 	it('relative with dot works for https', async() => {
 		const base = 'https://localhost/a/b/c.json';
 		const input : SeedReference = {
-			location: './f/e.json',
+			packet: './f/e.json',
 			id: 'foo'
 		};
 		const result = makeAbsolute(input, base);
 		const golden : AbsoluteSeedReference = {
-			location: 'https://localhost/a/b/f/e.json',
+			packet: 'https://localhost/a/b/f/e.json',
 			id: 'foo'
 		};
 		assert.deepStrictEqual(result, golden);