@townco/secret 0.1.45 → 0.1.47

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,107 +1,105 @@
1
1
  /**
2
2
  * Represents a line in an .env file
3
3
  */
4
- type EnvLine =
5
- | {
6
- type: "comment";
7
- content: string;
8
- }
9
- | {
10
- type: "blank";
11
- }
12
- | {
13
- type: "entry";
14
- key: string;
15
- value: string;
16
- raw: string;
17
- };
4
+ type EnvLine = {
5
+ type: "comment";
6
+ content: string;
7
+ } | {
8
+ type: "blank";
9
+ } | {
10
+ type: "entry";
11
+ key: string;
12
+ value: string;
13
+ raw: string;
14
+ };
18
15
  /**
19
16
  * A data structure that represents a parsed .env file while preserving
20
17
  * all original content including comments, blank lines, and order.
21
18
  */
22
19
  export declare class EnvFile {
23
- private lines;
24
- constructor(lines?: EnvLine[]);
25
- /**
26
- * Parse a .env file string into an EnvFile structure
27
- */
28
- static parse(content: string): EnvFile;
29
- /**
30
- * Serialize the EnvFile back to a string
31
- */
32
- toString(): string;
33
- /**
34
- * Get all entries as a key-value record
35
- */
36
- toRecord(): Record<string, string>;
37
- /**
38
- * Find an entry line by key
39
- */
40
- private findEntry;
41
- /**
42
- * Find the index of an entry by key
43
- */
44
- private findEntryIndex;
45
- /**
46
- * Create an entry line from key and value
47
- */
48
- private createEntry;
49
- /**
50
- * Normalize a value by ensuring it's properly quoted
51
- */
52
- private normalizeValue;
53
- /**
54
- * Find the insertion index for a new entry (before the final blank line if present)
55
- */
56
- private findInsertionIndex;
57
- /**
58
- * Get the value for a specific key
59
- */
60
- get(key: string): string | undefined;
61
- /**
62
- * Set a value for a key. If the key exists, updates it in place.
63
- * If it doesn't exist, appends it above the final newline (if present).
64
- * Values are always double quoted.
65
- */
66
- set(key: string, value: string): this;
67
- /**
68
- * Delete a key-value entry
69
- */
70
- delete(key: string): this;
71
- /**
72
- * Check if a key exists
73
- */
74
- has(key: string): boolean;
75
- /**
76
- * Get all keys
77
- */
78
- keys(): string[];
79
- /**
80
- * Iterate over all entries
81
- */
82
- entries(): IterableIterator<[string, string]>;
83
- /**
84
- * Apply a function to all entries and return a new EnvFile
85
- */
86
- map(fn: (key: string, value: string) => [string, string]): EnvFile;
87
- /**
88
- * Filter entries based on a predicate
89
- */
90
- filter(fn: (key: string, value: string) => boolean): EnvFile;
91
- /**
92
- * Add a comment line
93
- */
94
- addComment(content: string): this;
95
- /**
96
- * Add a blank line
97
- */
98
- addBlank(): this;
99
- /**
100
- * Get the raw lines array for custom operations
101
- */
102
- getLines(): readonly EnvLine[];
103
- /**
104
- * Create a clone of this EnvFile
105
- */
106
- clone(): EnvFile;
20
+ private lines;
21
+ constructor(lines?: EnvLine[]);
22
+ /**
23
+ * Parse a .env file string into an EnvFile structure
24
+ */
25
+ static parse(content: string): EnvFile;
26
+ /**
27
+ * Serialize the EnvFile back to a string
28
+ */
29
+ toString(): string;
30
+ /**
31
+ * Get all entries as a key-value record
32
+ */
33
+ toRecord(): Record<string, string>;
34
+ /**
35
+ * Find an entry line by key
36
+ */
37
+ private findEntry;
38
+ /**
39
+ * Find the index of an entry by key
40
+ */
41
+ private findEntryIndex;
42
+ /**
43
+ * Create an entry line from key and value
44
+ */
45
+ private createEntry;
46
+ /**
47
+ * Normalize a value by ensuring it's properly quoted
48
+ */
49
+ private normalizeValue;
50
+ /**
51
+ * Find the insertion index for a new entry (before the final blank line if present)
52
+ */
53
+ private findInsertionIndex;
54
+ /**
55
+ * Get the value for a specific key
56
+ */
57
+ get(key: string): string | undefined;
58
+ /**
59
+ * Set a value for a key. If the key exists, updates it in place.
60
+ * If it doesn't exist, appends it above the final newline (if present).
61
+ * Values are always double quoted.
62
+ */
63
+ set(key: string, value: string): this;
64
+ /**
65
+ * Delete a key-value entry
66
+ */
67
+ delete(key: string): this;
68
+ /**
69
+ * Check if a key exists
70
+ */
71
+ has(key: string): boolean;
72
+ /**
73
+ * Get all keys
74
+ */
75
+ keys(): string[];
76
+ /**
77
+ * Iterate over all entries
78
+ */
79
+ entries(): IterableIterator<[string, string]>;
80
+ /**
81
+ * Apply a function to all entries and return a new EnvFile
82
+ */
83
+ map(fn: (key: string, value: string) => [string, string]): EnvFile;
84
+ /**
85
+ * Filter entries based on a predicate
86
+ */
87
+ filter(fn: (key: string, value: string) => boolean): EnvFile;
88
+ /**
89
+ * Add a comment line
90
+ */
91
+ addComment(content: string): this;
92
+ /**
93
+ * Add a blank line
94
+ */
95
+ addBlank(): this;
96
+ /**
97
+ * Get the raw lines array for custom operations
98
+ */
99
+ getLines(): readonly EnvLine[];
100
+ /**
101
+ * Create a clone of this EnvFile
102
+ */
103
+ clone(): EnvFile;
107
104
  }
105
+ export {};
package/dist/index.d.ts CHANGED
@@ -1,15 +1,12 @@
1
1
  export { EnvFile } from "./env-file";
2
2
  export { type OnePassword, OnePassword as OpItem } from "./onepassword";
3
3
  export type SecretValidation = {
4
- key: string;
5
- value: string;
6
- valid: boolean;
7
- error?: string;
4
+ key: string;
5
+ value: string;
6
+ valid: boolean;
7
+ error?: string;
8
8
  };
9
9
  export declare const listSecrets: () => Promise<Promise<SecretValidation[]>>;
10
- export declare const createSecret: (
11
- name: string,
12
- value: string,
13
- ) => Promise<Promise<void>>;
10
+ export declare const createSecret: (name: string, value: string) => Promise<Promise<void>>;
14
11
  export declare const deleteSecret: (name: string) => Promise<Promise<void>>;
15
12
  export declare const genenv: () => Promise<Promise<void>>;
@@ -2,107 +2,101 @@ import type { FullItem } from "@1password/connect";
2
2
  /**
3
3
  * Represents a change to be made to a 1Password item
4
4
  */
5
- type OnePasswordChange =
6
- | {
7
- type: "add";
8
- key: string;
9
- value: string;
10
- }
11
- | {
12
- type: "update";
13
- key: string;
14
- value: string;
15
- }
16
- | {
17
- type: "delete";
18
- key: string;
19
- };
5
+ type OnePasswordChange = {
6
+ type: "add";
7
+ key: string;
8
+ value: string;
9
+ } | {
10
+ type: "update";
11
+ key: string;
12
+ value: string;
13
+ } | {
14
+ type: "delete";
15
+ key: string;
16
+ };
20
17
  /**
21
18
  * A data structure that represents a 1Password item and provides
22
19
  * methods to detect changes and generate appropriate `op` CLI commands.
23
20
  */
24
21
  export declare class OnePassword {
25
- private vault;
26
- private item;
27
- private fields;
28
- private originalFields;
29
- constructor(vault: string, item: string, fields?: Map<string, string>);
30
- /**
31
- * Create an OpItem from a 1Password FullItem JSON response
32
- */
33
- static fromFullItem(
34
- vault: string,
35
- itemName: string,
36
- fullItem: FullItem,
37
- ): OnePassword;
38
- /**
39
- * Fetch an OpItem from 1Password using the CLI
40
- */
41
- static fetch(vault: string, item: string): Promise<OnePassword>;
42
- /**
43
- * Sign in to 1Password CLI
44
- */
45
- static signin(): Promise<void>;
46
- /**
47
- * Get a field value
48
- */
49
- get(key: string): string | undefined;
50
- /**
51
- * Set a field value (marks as changed)
52
- */
53
- set(key: string, value: string): this;
54
- /**
55
- * Delete a field (marks as deleted)
56
- */
57
- delete(key: string): this;
58
- /**
59
- * Check if a field exists
60
- */
61
- has(key: string): boolean;
62
- /**
63
- * Get all field keys
64
- */
65
- keys(): string[];
66
- /**
67
- * Get all fields as a record
68
- */
69
- toRecord(): Record<string, string>;
70
- /**
71
- * Get all field entries
72
- */
73
- entries(): IterableIterator<[string, string]>;
74
- /**
75
- * Build an op:// reference for a field
76
- */
77
- getReference(key: string): string;
78
- /**
79
- * Detect changes between original and current state
80
- */
81
- detectChanges(): OnePasswordChange[];
82
- /**
83
- * Generate op CLI arguments for a single change
84
- */
85
- private buildEditArgs;
86
- /**
87
- * Apply all changes to 1Password using the op CLI
88
- * Returns the number of changes applied
89
- */
90
- sync(): Promise<number>;
91
- /**
92
- * Inject secrets from a template file to an output file
93
- * This resolves op:// references to actual values
94
- */
95
- static inject(inputPath: string, outputPath: string): Promise<void>;
96
- /**
97
- * Create a clone of this OpItem
98
- */
99
- clone(): OnePassword;
100
- /**
101
- * Reset to original state (discard changes)
102
- */
103
- reset(): this;
104
- /**
105
- * Check if there are unsaved changes
106
- */
107
- hasChanges(): boolean;
22
+ private vault;
23
+ private item;
24
+ private fields;
25
+ private originalFields;
26
+ constructor(vault: string, item: string, fields?: Map<string, string>);
27
+ /**
28
+ * Create an OpItem from a 1Password FullItem JSON response
29
+ */
30
+ static fromFullItem(vault: string, itemName: string, fullItem: FullItem): OnePassword;
31
+ /**
32
+ * Fetch an OpItem from 1Password using the CLI
33
+ */
34
+ static fetch(vault: string, item: string): Promise<OnePassword>;
35
+ /**
36
+ * Sign in to 1Password CLI
37
+ */
38
+ static signin(): Promise<void>;
39
+ /**
40
+ * Get a field value
41
+ */
42
+ get(key: string): string | undefined;
43
+ /**
44
+ * Set a field value (marks as changed)
45
+ */
46
+ set(key: string, value: string): this;
47
+ /**
48
+ * Delete a field (marks as deleted)
49
+ */
50
+ delete(key: string): this;
51
+ /**
52
+ * Check if a field exists
53
+ */
54
+ has(key: string): boolean;
55
+ /**
56
+ * Get all field keys
57
+ */
58
+ keys(): string[];
59
+ /**
60
+ * Get all fields as a record
61
+ */
62
+ toRecord(): Record<string, string>;
63
+ /**
64
+ * Get all field entries
65
+ */
66
+ entries(): IterableIterator<[string, string]>;
67
+ /**
68
+ * Build an op:// reference for a field
69
+ */
70
+ getReference(key: string): string;
71
+ /**
72
+ * Detect changes between original and current state
73
+ */
74
+ detectChanges(): OnePasswordChange[];
75
+ /**
76
+ * Generate op CLI arguments for a single change
77
+ */
78
+ private buildEditArgs;
79
+ /**
80
+ * Apply all changes to 1Password using the op CLI
81
+ * Returns the number of changes applied
82
+ */
83
+ sync(): Promise<number>;
84
+ /**
85
+ * Inject secrets from a template file to an output file
86
+ * This resolves op:// references to actual values
87
+ */
88
+ static inject(inputPath: string, outputPath: string): Promise<void>;
89
+ /**
90
+ * Create a clone of this OpItem
91
+ */
92
+ clone(): OnePassword;
93
+ /**
94
+ * Reset to original state (discard changes)
95
+ */
96
+ reset(): this;
97
+ /**
98
+ * Check if there are unsaved changes
99
+ */
100
+ hasChanges(): boolean;
108
101
  }
102
+ export {};
@@ -0,0 +1,101 @@
1
+ import type { FullItem } from "@1password/connect";
2
+ /**
3
+ * Represents a change to be made to a 1Password item
4
+ */
5
+ export type OpChange = {
6
+ type: "add";
7
+ key: string;
8
+ value: string;
9
+ } | {
10
+ type: "update";
11
+ key: string;
12
+ value: string;
13
+ } | {
14
+ type: "delete";
15
+ key: string;
16
+ };
17
+ /**
18
+ * A data structure that represents a 1Password item and provides
19
+ * methods to detect changes and generate appropriate `op` CLI commands.
20
+ */
21
+ export declare class OpItem {
22
+ private vault;
23
+ private item;
24
+ private fields;
25
+ private originalFields;
26
+ constructor(vault: string, item: string, fields?: Map<string, string>);
27
+ /**
28
+ * Create an OpItem from a 1Password FullItem JSON response
29
+ */
30
+ static fromFullItem(vault: string, itemName: string, fullItem: FullItem): OpItem;
31
+ /**
32
+ * Fetch an OpItem from 1Password using the CLI
33
+ */
34
+ static fetch(vault: string, item: string): Promise<OpItem>;
35
+ /**
36
+ * Sign in to 1Password CLI
37
+ */
38
+ static signin(): Promise<void>;
39
+ /**
40
+ * Get a field value
41
+ */
42
+ get(key: string): string | undefined;
43
+ /**
44
+ * Set a field value (marks as changed)
45
+ */
46
+ set(key: string, value: string): this;
47
+ /**
48
+ * Delete a field (marks as deleted)
49
+ */
50
+ delete(key: string): this;
51
+ /**
52
+ * Check if a field exists
53
+ */
54
+ has(key: string): boolean;
55
+ /**
56
+ * Get all field keys
57
+ */
58
+ keys(): string[];
59
+ /**
60
+ * Get all fields as a record
61
+ */
62
+ toRecord(): Record<string, string>;
63
+ /**
64
+ * Get all field entries
65
+ */
66
+ entries(): IterableIterator<[string, string]>;
67
+ /**
68
+ * Build an op:// reference for a field
69
+ */
70
+ getReference(key: string): string;
71
+ /**
72
+ * Detect changes between original and current state
73
+ */
74
+ detectChanges(): OpChange[];
75
+ /**
76
+ * Generate op CLI arguments for a single change
77
+ */
78
+ private buildEditArgs;
79
+ /**
80
+ * Apply all changes to 1Password using the op CLI
81
+ * Returns the number of changes applied
82
+ */
83
+ sync(): Promise<number>;
84
+ /**
85
+ * Inject secrets from a template file to an output file
86
+ * This resolves op:// references to actual values
87
+ */
88
+ static inject(inputPath: string, outputPath: string): Promise<void>;
89
+ /**
90
+ * Create a clone of this OpItem
91
+ */
92
+ clone(): OpItem;
93
+ /**
94
+ * Reset to original state (discard changes)
95
+ */
96
+ reset(): this;
97
+ /**
98
+ * Check if there are unsaved changes
99
+ */
100
+ hasChanges(): boolean;
101
+ }
@@ -0,0 +1,203 @@
1
+ /**
2
+ * A data structure that represents a 1Password item and provides
3
+ * methods to detect changes and generate appropriate `op` CLI commands.
4
+ */
5
+ export class OpItem {
6
+ vault;
7
+ item;
8
+ fields;
9
+ originalFields;
10
+ constructor(vault, item, fields = new Map()) {
11
+ this.vault = vault;
12
+ this.item = item;
13
+ this.fields = new Map(fields);
14
+ this.originalFields = new Map(fields);
15
+ }
16
+ /**
17
+ * Create an OpItem from a 1Password FullItem JSON response
18
+ */
19
+ static fromFullItem(vault, itemName, fullItem) {
20
+ const fields = new Map();
21
+ if (fullItem.fields) {
22
+ for (const field of fullItem.fields) {
23
+ if (field.label && field.value) {
24
+ fields.set(field.label, field.value);
25
+ }
26
+ }
27
+ }
28
+ return new OpItem(vault, itemName, fields);
29
+ }
30
+ /**
31
+ * Fetch an OpItem from 1Password using the CLI
32
+ */
33
+ static async fetch(vault, item) {
34
+ try {
35
+ const proc = Bun.spawn([
36
+ "op",
37
+ "--format=json",
38
+ "item",
39
+ "get",
40
+ "--vault",
41
+ vault,
42
+ item,
43
+ ]);
44
+ const output = await new Response(proc.stdout).text();
45
+ await proc.exited;
46
+ const fullItem = JSON.parse(output);
47
+ return OpItem.fromFullItem(vault, item, fullItem);
48
+ }
49
+ catch (error) {
50
+ throw new Error(`Failed to fetch item '${item}' from vault '${vault}': ${error}`);
51
+ }
52
+ }
53
+ /**
54
+ * Sign in to 1Password CLI
55
+ */
56
+ static async signin() {
57
+ await Bun.spawn(["op", "signin"]).exited;
58
+ }
59
+ /**
60
+ * Get a field value
61
+ */
62
+ get(key) {
63
+ return this.fields.get(key);
64
+ }
65
+ /**
66
+ * Set a field value (marks as changed)
67
+ */
68
+ set(key, value) {
69
+ this.fields.set(key, value);
70
+ return this;
71
+ }
72
+ /**
73
+ * Delete a field (marks as deleted)
74
+ */
75
+ delete(key) {
76
+ this.fields.delete(key);
77
+ return this;
78
+ }
79
+ /**
80
+ * Check if a field exists
81
+ */
82
+ has(key) {
83
+ return this.fields.has(key);
84
+ }
85
+ /**
86
+ * Get all field keys
87
+ */
88
+ keys() {
89
+ return Array.from(this.fields.keys());
90
+ }
91
+ /**
92
+ * Get all fields as a record
93
+ */
94
+ toRecord() {
95
+ return Object.fromEntries(this.fields);
96
+ }
97
+ /**
98
+ * Get all field entries
99
+ */
100
+ entries() {
101
+ return this.fields.entries();
102
+ }
103
+ /**
104
+ * Build an op:// reference for a field
105
+ */
106
+ getReference(key) {
107
+ return `op://${this.vault}/${this.item}/${key}`;
108
+ }
109
+ /**
110
+ * Detect changes between original and current state
111
+ */
112
+ detectChanges() {
113
+ const changes = [];
114
+ // Check for deletions
115
+ for (const key of this.originalFields.keys()) {
116
+ if (!this.fields.has(key)) {
117
+ changes.push({ type: "delete", key });
118
+ }
119
+ }
120
+ // Check for additions and updates
121
+ for (const [key, value] of this.fields.entries()) {
122
+ const originalValue = this.originalFields.get(key);
123
+ if (originalValue === undefined) {
124
+ changes.push({ type: "add", key, value });
125
+ }
126
+ else if (originalValue !== value) {
127
+ changes.push({ type: "update", key, value });
128
+ }
129
+ }
130
+ return changes;
131
+ }
132
+ /**
133
+ * Generate op CLI arguments for a single change
134
+ */
135
+ buildEditArgs(change) {
136
+ switch (change.type) {
137
+ case "add":
138
+ case "update":
139
+ return [`${change.key}[password]=${change.value}`];
140
+ case "delete":
141
+ return [`${change.key}[delete]`];
142
+ }
143
+ }
144
+ /**
145
+ * Apply all changes to 1Password using the op CLI
146
+ * Returns the number of changes applied
147
+ */
148
+ async sync() {
149
+ const changes = this.detectChanges();
150
+ if (changes.length === 0) {
151
+ return 0;
152
+ }
153
+ // Build all edit arguments
154
+ const editArgs = changes.flatMap((change) => this.buildEditArgs(change));
155
+ // Execute a single op item edit command with all changes
156
+ await Bun.spawn([
157
+ "op",
158
+ "item",
159
+ "edit",
160
+ this.item,
161
+ "--vault",
162
+ this.vault,
163
+ ...editArgs,
164
+ ]).exited;
165
+ // Update originalFields to match current state
166
+ this.originalFields = new Map(this.fields);
167
+ return changes.length;
168
+ }
169
+ /**
170
+ * Inject secrets from a template file to an output file
171
+ * This resolves op:// references to actual values
172
+ */
173
+ static async inject(inputPath, outputPath) {
174
+ await Bun.spawn([
175
+ "op",
176
+ "inject",
177
+ "-i",
178
+ inputPath,
179
+ "-o",
180
+ outputPath,
181
+ "--force",
182
+ ]).exited;
183
+ }
184
+ /**
185
+ * Create a clone of this OpItem
186
+ */
187
+ clone() {
188
+ return new OpItem(this.vault, this.item, new Map(this.fields));
189
+ }
190
+ /**
191
+ * Reset to original state (discard changes)
192
+ */
193
+ reset() {
194
+ this.fields = new Map(this.originalFields);
195
+ return this;
196
+ }
197
+ /**
198
+ * Check if there are unsaved changes
199
+ */
200
+ hasChanges() {
201
+ return this.detectChanges().length > 0;
202
+ }
203
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@townco/secret",
3
- "version": "0.1.45",
3
+ "version": "0.1.47",
4
4
  "type": "module",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
@@ -23,7 +23,7 @@
23
23
  "@1password/connect": "^1.4.2"
24
24
  },
25
25
  "devDependencies": {
26
- "@townco/tsconfig": "0.1.42",
26
+ "@townco/tsconfig": "0.1.44",
27
27
  "@types/bun": "^1.3.1"
28
28
  }
29
29
  }