@travetto/model 8.0.0-alpha.17 → 8.0.0-alpha.19

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 CHANGED
@@ -180,12 +180,13 @@ export interface ModelBlobSupport {
180
180
  updateBlobMetadata(location: string, metadata: BinaryMetadata): Promise<void>;
181
181
 
182
182
  /**
183
- * Produces an externally usable URL for sharing limited read access to a specific resource
183
+ * Produces an externally usable URL for sharing limited read access to a specific resource.
184
+ * If expiresIn is explicitly set to false, returns a direct/public URL.
184
185
  *
185
186
  * @param location The asset location to read from
186
- * @param expiresIn Expiry
187
+ * @param expiresIn Expiry or false for public/direct URL
187
188
  */
188
- getBlobReadUrl?(location: string, expiresIn?: TimeSpan): Promise<string>;
189
+ getBlobReadUrl?(location: string, expiresIn?: TimeSpan | false): Promise<string>;
189
190
 
190
191
  /**
191
192
  * Produces an externally usable URL for sharing allowing direct write access
@@ -318,11 +319,11 @@ $ trv model:export --help
318
319
 
319
320
  Usage: model:export [options] <provider:string> <models...:string>
320
321
 
321
- Export model definitions for a selected provider and model set.
322
+ Description:
323
+ Export model definitions for a selected provider and model set.
322
324
 
323
- The command resolves candidate models and delegates to provider-specific
324
- export logic to produce schema/install artifacts.
325
- Example Usage:
325
+ The command resolves candidate models and delegates to provider-specific
326
+ export logic to produce schema/install artifacts.
326
327
 
327
328
  Options:
328
329
  -p, --profile <string> Application profiles
@@ -336,6 +337,8 @@ Providers
336
337
  Models
337
338
  --------------------
338
339
  * samplemodel
340
+
341
+ Examples:
339
342
  ```
340
343
 
341
344
  ## CLI - model:install
@@ -347,11 +350,11 @@ $ trv model:install --help
347
350
 
348
351
  Usage: model:install [options] <provider:string> <models...:string>
349
352
 
350
- Install or update model definitions for a selected provider.
353
+ Description:
354
+ Install or update model definitions for a selected provider.
351
355
 
352
- The command resolves candidate models and applies provider install/upsert
353
- operations so backing stores are prepared for runtime usage.
354
- Example Usage:
356
+ The command resolves candidate models and applies provider install/upsert
357
+ operations so backing stores are prepared for runtime usage.
355
358
 
356
359
  Options:
357
360
  -p, --profile <string> Application profiles
@@ -365,4 +368,6 @@ Providers
365
368
  Models
366
369
  --------------------
367
370
  * samplemodel
371
+
372
+ Examples:
368
373
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@travetto/model",
3
- "version": "8.0.0-alpha.17",
3
+ "version": "8.0.0-alpha.19",
4
4
  "type": "module",
5
5
  "description": "Datastore abstraction for core operations.",
6
6
  "keywords": [
@@ -27,14 +27,14 @@
27
27
  "directory": "module/model"
28
28
  },
29
29
  "dependencies": {
30
- "@travetto/config": "^8.0.0-alpha.17",
31
- "@travetto/di": "^8.0.0-alpha.16",
32
- "@travetto/registry": "^8.0.0-alpha.16",
33
- "@travetto/schema": "^8.0.0-alpha.17"
30
+ "@travetto/config": "^8.0.0-alpha.18",
31
+ "@travetto/di": "^8.0.0-alpha.17",
32
+ "@travetto/registry": "^8.0.0-alpha.17",
33
+ "@travetto/schema": "^8.0.0-alpha.18"
34
34
  },
35
35
  "peerDependencies": {
36
- "@travetto/cli": "^8.0.0-alpha.22",
37
- "@travetto/test": "^8.0.0-alpha.16"
36
+ "@travetto/cli": "^8.0.0-alpha.24",
37
+ "@travetto/test": "^8.0.0-alpha.17"
38
38
  },
39
39
  "peerDependenciesMeta": {
40
40
  "@travetto/cli": {
package/src/types/blob.ts CHANGED
@@ -42,12 +42,13 @@ export interface ModelBlobSupport {
42
42
  updateBlobMetadata(location: string, metadata: BinaryMetadata): Promise<void>;
43
43
 
44
44
  /**
45
- * Produces an externally usable URL for sharing limited read access to a specific resource
45
+ * Produces an externally usable URL for sharing limited read access to a specific resource.
46
+ * If expiresIn is explicitly set to false, returns a direct/public URL.
46
47
  *
47
48
  * @param location The asset location to read from
48
- * @param expiresIn Expiry
49
+ * @param expiresIn Expiry or false for public/direct URL
49
50
  */
50
- getBlobReadUrl?(location: string, expiresIn?: TimeSpan): Promise<string>;
51
+ getBlobReadUrl?(location: string, expiresIn?: TimeSpan | false): Promise<string>;
51
52
 
52
53
  /**
53
54
  * Produces an externally usable URL for sharing allowing direct write access