@oddington/cli 0.1.65 → 0.1.66
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.
- package/README.md +26 -8
- package/dist/os.js +343 -312
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -77,6 +77,19 @@ Data and shared Files go directly to their OS owners. Local publication validate
|
|
|
77
77
|
the whole captured set before applying Records, retaining Files and publishing
|
|
78
78
|
Asks/Digests; retry resumes the same retained identities and receipts.
|
|
79
79
|
|
|
80
|
+
## Add a Data repository
|
|
81
|
+
|
|
82
|
+
Use an existing, enabled Git repository in your workspace:
|
|
83
|
+
|
|
84
|
+
```sh
|
|
85
|
+
os repository add project-management --workspace example --git-repository workspace
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
The Data repository name selects the top-level `project-management/` directory.
|
|
89
|
+
OS checks its collection schemas, saves the binding and starts preparing the data.
|
|
90
|
+
The result reports `preparing` or `ready`; repeating the same command resumes setup.
|
|
91
|
+
Configure the Git repository separately through Connections.
|
|
92
|
+
|
|
80
93
|
## Repository schema types
|
|
81
94
|
|
|
82
95
|
Inside a TypeScript code repository with a GitHub origin and named branch, run:
|
|
@@ -284,7 +297,7 @@ Creating a connection verifies access before saving it. It does not grant
|
|
|
284
297
|
anyone permission to use it.
|
|
285
298
|
|
|
286
299
|
Outlook and SharePoint are separate connections for one mailbox or site. Both
|
|
287
|
-
require tenant and application IDs
|
|
300
|
+
require tenant and application IDs and protected credential
|
|
288
301
|
JSON from stdin:
|
|
289
302
|
|
|
290
303
|
```sh
|
|
@@ -309,11 +322,14 @@ credential-source | os connection create sharepoint \
|
|
|
309
322
|
|
|
310
323
|
Each expects an object containing only `clientSecret`. The entire UTF-8 stdin
|
|
311
324
|
input must fit within 4,096 bytes. The secret never belongs in command arguments.
|
|
312
|
-
|
|
313
|
-
|
|
325
|
+
`--access` is optional nonempty descriptive metadata for either provider.
|
|
326
|
+
Supplied descriptions, including existing `read` and `read-write` values, are
|
|
327
|
+
preserved. They do not restrict or verify Microsoft permissions and are omitted
|
|
328
|
+
from safe output when absent. This metadata change requires no credential re-entry.
|
|
329
|
+
OS resolves the SharePoint site ID during verification; callers cannot supply it.
|
|
314
330
|
The Entra application's Microsoft permissions and site or mailbox grants must
|
|
315
|
-
already be configured upstream.
|
|
316
|
-
|
|
331
|
+
already be configured upstream. Routine code owns ordinary Microsoft Graph
|
|
332
|
+
operations; OS does not provide an operations SDK or SharePoint File storage.
|
|
317
333
|
|
|
318
334
|
### Test a connection
|
|
319
335
|
|
|
@@ -337,7 +353,7 @@ prove that the credential can write records.
|
|
|
337
353
|
Outlook testing reads only the configured mailbox's inbox folder identity,
|
|
338
354
|
without reading messages or attachments. SharePoint testing resolves the site
|
|
339
355
|
URL to its saved ID and reads that site. Success establishes readable access
|
|
340
|
-
only, including when
|
|
356
|
+
only, including when the access description is `read-write`; it does not prove write
|
|
341
357
|
access or the absence of broader Microsoft access. Inspect shows the complete
|
|
342
358
|
public configuration, including the verified SharePoint site ID.
|
|
343
359
|
|
|
@@ -550,8 +566,10 @@ Record files for review. Explicit `os routine publish` sends the logical journal
|
|
|
550
566
|
|
|
551
567
|
OS intersects the routine's declared access with configured workspace
|
|
552
568
|
capabilities. A new routine runs locally from a customer branch without
|
|
553
|
-
registration, a merge to main, or deployment.
|
|
554
|
-
|
|
569
|
+
registration, a merge to main, or deployment. Write the canonical `id` as a literal
|
|
570
|
+
string directly in `defineRoutine`, such as `id: 'invoice-import'`; use that same
|
|
571
|
+
ID in the command. OS reads the declared IDs before preparing only the selected
|
|
572
|
+
routine. Named connections
|
|
555
573
|
must already be configured in the workspace; declaring a name does not create it:
|
|
556
574
|
|
|
557
575
|
```sh
|