@codelockpro/sdk 0.1.14 → 0.1.16
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 +15 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -70,6 +70,21 @@ import { createCommunityModule } from "@codelockpro/sdk/community";
|
|
|
70
70
|
client.register("community", createCommunityModule);
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
+
Migration notes for integrators:
|
|
74
|
+
|
|
75
|
+
- **JS module surface:** migrate `community` imports/registration to
|
|
76
|
+
`@codelockpro/sdk/portal`, `createPortalModule`, and `client.portal()`.
|
|
77
|
+
- **Event namespaces:** prefer `portal.thread.created`,
|
|
78
|
+
`portal.post.created`, `portal.thread.flagged`,
|
|
79
|
+
`portal.post.flagged`. Keep `community.*` listeners only while older
|
|
80
|
+
integrations are still registered as `community`.
|
|
81
|
+
- **Routes/endpoints:** forum traffic should target portal naming
|
|
82
|
+
consistently (`/portal/*` proxy routes, upstream
|
|
83
|
+
`/v1/portal/forum/*` endpoints).
|
|
84
|
+
- **Compatibility window:** `community` naming remains supported for the
|
|
85
|
+
current `0.x` SDK line and will only be removed in a future major
|
|
86
|
+
release with advance notice.
|
|
87
|
+
|
|
73
88
|
## Registering more modules
|
|
74
89
|
|
|
75
90
|
```ts
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@codelockpro/sdk",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.16",
|
|
4
4
|
"description": "Framework-agnostic, modular client SDK for CodeLockPro. Module one: Knowledge base. Configured with the developer's own base URL — never communicates directly with the CodeLockPro API.",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE",
|
|
6
6
|
"homepage": "https://github.com/mbos01/codelockpro/tree/main/sdk/js#readme",
|