transloadit 6.2.0 → 6.2.1
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 +14 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -45,6 +45,20 @@ npm install --save @transloadit/node
|
|
|
45
45
|
The legacy npm package name `transloadit` is kept as an alias for backward compatibility, but
|
|
46
46
|
`@transloadit/node` is the canonical package name.
|
|
47
47
|
|
|
48
|
+
## Versioning and dependency updates
|
|
49
|
+
|
|
50
|
+
The SDK surface follows strict SemVer. API contract types and schemas follow API2 and can change
|
|
51
|
+
in minor releases, including type-breaking updates. See the
|
|
52
|
+
[versioning policy](https://github.com/transloadit/node-sdk/blob/main/CONTRIBUTING.md#versioning-policy).
|
|
53
|
+
|
|
54
|
+
- Commit your lockfile and type-check dependency update PRs.
|
|
55
|
+
- Use `~` ranges for stable contract types within a minor; patch releases do not change contract
|
|
56
|
+
types. Use `^` to follow the API as it evolves.
|
|
57
|
+
- Use input types for instructions you write, for example
|
|
58
|
+
`const params = { steps } satisfies CreateAssemblyParams`.
|
|
59
|
+
- Narrow fields from responses and parsed output before use (`null`, `undefined`, unknown strings).
|
|
60
|
+
- Do not depend on Zod internals such as wrapper classes, `.shape` or parse-time defaults.
|
|
61
|
+
|
|
48
62
|
## Command Line Interface (CLI)
|
|
49
63
|
|
|
50
64
|
This package includes a full-featured CLI for interacting with Transloadit from your terminal.
|