@imferno/node 2.0.1-beta.bc33900 → 2.0.1-docs-nav-guide-reference.8442d4b

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.
Files changed (2) hide show
  1. package/README.md +19 -0
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -33,6 +33,25 @@ console.log("Warnings:", report.validation.warnings.length);
33
33
  console.log("CPLs:", report.package.cplCount);
34
34
  ```
35
35
 
36
+ ### Validate from a URI (filesystem or S3)
37
+
38
+ ```js
39
+ import { validateUri, buildReportFromUri } from "@imferno/node";
40
+
41
+ // Local FS path or file:// URI
42
+ const result = validateUri("./my-imp");
43
+ const result2 = validateUri("file:///abs/path/to/my-imp");
44
+
45
+ // S3 (requires the binary to be built with the aws-s3 feature; uses the
46
+ // default AWS credential chain — env vars, profile, or IMDS)
47
+ const result3 = validateUri("s3://my-bucket/path/to/imp/");
48
+
49
+ // Same options object as validatePath
50
+ const report = buildReportFromUri("s3://my-bucket/path/to/imp/", {
51
+ coreSpec: "v2020",
52
+ });
53
+ ```
54
+
36
55
  ### Validate with options
37
56
 
38
57
  ```js
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@imferno/node",
3
- "version": "2.0.1-beta.bc33900",
3
+ "version": "2.0.1-docs-nav-guide-reference.8442d4b",
4
4
  "description": "Native Node.js bindings for the imferno SMPTE ST 2067 IMF validator",
5
5
  "main": "index.js",
6
6
  "module": "index.mjs",
@@ -39,12 +39,12 @@
39
39
  "LICENSE"
40
40
  ],
41
41
  "optionalDependencies": {
42
- "@imferno/darwin-arm64": "2.0.1-beta.bc33900",
43
- "@imferno/darwin-x64": "2.0.1-beta.bc33900",
44
- "@imferno/linux-x64-gnu": "2.0.1-beta.bc33900",
45
- "@imferno/linux-arm64-gnu": "2.0.1-beta.bc33900",
46
- "@imferno/win32-x64-msvc": "2.0.1-beta.bc33900",
47
- "@imferno/win32-arm64-msvc": "2.0.1-beta.bc33900"
42
+ "@imferno/darwin-arm64": "2.0.1-docs-nav-guide-reference.8442d4b",
43
+ "@imferno/darwin-x64": "2.0.1-docs-nav-guide-reference.8442d4b",
44
+ "@imferno/linux-x64-gnu": "2.0.1-docs-nav-guide-reference.8442d4b",
45
+ "@imferno/linux-arm64-gnu": "2.0.1-docs-nav-guide-reference.8442d4b",
46
+ "@imferno/win32-x64-msvc": "2.0.1-docs-nav-guide-reference.8442d4b",
47
+ "@imferno/win32-arm64-msvc": "2.0.1-docs-nav-guide-reference.8442d4b"
48
48
  },
49
49
  "publishConfig": {
50
50
  "access": "public"