fastcomments-sdk 2.1.1 → 2.1.2
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 +4 -0
- package/dist/browser.d.ts +2 -4
- package/dist/browser.d.ts.map +1 -1
- package/dist/browser.js +1 -11
- package/dist/browser.js.map +1 -1
- package/dist/generated/src/apis/PublicApi.d.ts +1 -1
- package/dist/generated/src/apis/index.d.ts +0 -1
- package/dist/generated/src/apis/index.d.ts.map +1 -1
- package/dist/generated/src/apis/index.js +0 -1
- package/dist/generated/src/apis/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,10 @@ Official Node.js and TypeScript SDK for the FastComments API. Build secure and s
|
|
|
8
8
|
npm install fastcomments-sdk
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
## API Documentation
|
|
12
|
+
|
|
13
|
+
Full API reference: [docs/api/README.md](docs/api/README.md)
|
|
14
|
+
|
|
11
15
|
## Browser vs Server Compatibility
|
|
12
16
|
|
|
13
17
|
This SDK uses **dual entry points** to ensure optimal compatibility and prevent runtime errors:
|
package/dist/browser.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export * from './generated/src/apis';
|
|
2
2
|
export * from './generated/src/models';
|
|
3
3
|
export { Configuration } from './generated/src/runtime';
|
|
4
|
-
export { DefaultApi, PublicApi
|
|
4
|
+
export { DefaultApi, PublicApi } from './generated/src/apis';
|
|
5
5
|
export { createURLQueryString, isAPIError, debounce, makeRequest } from './live/utils';
|
|
6
6
|
export { default as subscribeToChanges } from './live/subscribe-to-changes';
|
|
7
7
|
export type { SubscribeToChangesResult, SubscribeToChangesConfig } from './live/subscribe-to-changes';
|
|
@@ -9,7 +9,7 @@ export { subscribeToUserFeed } from './live/user-feed';
|
|
|
9
9
|
export type { UserFeedConfig } from './live/user-feed';
|
|
10
10
|
export type { LiveEvent, LiveEventType, EventLogEntry, PubSubComment, PubSubVote, FeedPost, UserNotification } from './generated/src/index';
|
|
11
11
|
export type * from './sso/types';
|
|
12
|
-
import { DefaultApi, PublicApi
|
|
12
|
+
import { DefaultApi, PublicApi } from './generated/src/apis';
|
|
13
13
|
export interface FastCommentsBrowserSDKConfig {
|
|
14
14
|
apiKey?: string;
|
|
15
15
|
basePath?: string;
|
|
@@ -18,12 +18,10 @@ export declare class FastCommentsBrowserSDK {
|
|
|
18
18
|
private config;
|
|
19
19
|
private _defaultApi;
|
|
20
20
|
private _publicApi;
|
|
21
|
-
private _hiddenApi;
|
|
22
21
|
constructor(config?: FastCommentsBrowserSDKConfig);
|
|
23
22
|
private getConfiguration;
|
|
24
23
|
get defaultApi(): DefaultApi;
|
|
25
24
|
get publicApi(): PublicApi;
|
|
26
|
-
get hiddenApi(): HiddenApi;
|
|
27
25
|
/**
|
|
28
26
|
* Update the API key for authenticated requests
|
|
29
27
|
*/
|
package/dist/browser.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAIA,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,
|
|
1
|
+
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAIA,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAG7D,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACvF,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAC5E,YAAY,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACtG,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGvD,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAG5I,mBAAmB,aAAa,CAAC;AAGjC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAG7D,MAAM,WAAW,4BAA4B;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,sBAAsB;IACjC,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,WAAW,CAA2B;IAC9C,OAAO,CAAC,UAAU,CAA0B;gBAEhC,MAAM,GAAE,4BAAiC;IAOrD,OAAO,CAAC,gBAAgB;IAOxB,IAAW,UAAU,IAAI,UAAU,CAKlC;IAED,IAAW,SAAS,IAAI,SAAS,CAKhC;IAED;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAM/B;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;CAKpC;AAGD,wBAAgB,4BAA4B,CAAC,MAAM,CAAC,EAAE,4BAA4B,GAAG,sBAAsB,CAE1G"}
|
package/dist/browser.js
CHANGED
|
@@ -19,7 +19,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
19
19
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
20
20
|
};
|
|
21
21
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
22
|
-
exports.FastCommentsBrowserSDK = exports.subscribeToUserFeed = exports.subscribeToChanges = exports.makeRequest = exports.debounce = exports.isAPIError = exports.createURLQueryString = exports.
|
|
22
|
+
exports.FastCommentsBrowserSDK = exports.subscribeToUserFeed = exports.subscribeToChanges = exports.makeRequest = exports.debounce = exports.isAPIError = exports.createURLQueryString = exports.PublicApi = exports.DefaultApi = exports.Configuration = void 0;
|
|
23
23
|
exports.createFastCommentsBrowserSDK = createFastCommentsBrowserSDK;
|
|
24
24
|
// Export the generated API client (fetch-based, works in browsers)
|
|
25
25
|
__exportStar(require("./generated/src/apis"), exports);
|
|
@@ -30,7 +30,6 @@ Object.defineProperty(exports, "Configuration", { enumerable: true, get: functio
|
|
|
30
30
|
var apis_1 = require("./generated/src/apis");
|
|
31
31
|
Object.defineProperty(exports, "DefaultApi", { enumerable: true, get: function () { return apis_1.DefaultApi; } });
|
|
32
32
|
Object.defineProperty(exports, "PublicApi", { enumerable: true, get: function () { return apis_1.PublicApi; } });
|
|
33
|
-
Object.defineProperty(exports, "HiddenApi", { enumerable: true, get: function () { return apis_1.HiddenApi; } });
|
|
34
33
|
// Export client-safe live utilities (fetch-based WebSocket fallbacks)
|
|
35
34
|
var utils_1 = require("./live/utils");
|
|
36
35
|
Object.defineProperty(exports, "createURLQueryString", { enumerable: true, get: function () { return utils_1.createURLQueryString; } });
|
|
@@ -48,7 +47,6 @@ class FastCommentsBrowserSDK {
|
|
|
48
47
|
constructor(config = {}) {
|
|
49
48
|
this._defaultApi = null;
|
|
50
49
|
this._publicApi = null;
|
|
51
|
-
this._hiddenApi = null;
|
|
52
50
|
this.config = { ...config };
|
|
53
51
|
if (!this.config.basePath) {
|
|
54
52
|
this.config.basePath = 'https://fastcomments.com';
|
|
@@ -72,12 +70,6 @@ class FastCommentsBrowserSDK {
|
|
|
72
70
|
}
|
|
73
71
|
return this._publicApi;
|
|
74
72
|
}
|
|
75
|
-
get hiddenApi() {
|
|
76
|
-
if (!this._hiddenApi) {
|
|
77
|
-
this._hiddenApi = new apis_2.HiddenApi(this.getConfiguration());
|
|
78
|
-
}
|
|
79
|
-
return this._hiddenApi;
|
|
80
|
-
}
|
|
81
73
|
/**
|
|
82
74
|
* Update the API key for authenticated requests
|
|
83
75
|
*/
|
|
@@ -85,7 +77,6 @@ class FastCommentsBrowserSDK {
|
|
|
85
77
|
this.config.apiKey = apiKey;
|
|
86
78
|
this._defaultApi = null;
|
|
87
79
|
this._publicApi = null;
|
|
88
|
-
this._hiddenApi = null;
|
|
89
80
|
}
|
|
90
81
|
/**
|
|
91
82
|
* Update the base path for API requests
|
|
@@ -94,7 +85,6 @@ class FastCommentsBrowserSDK {
|
|
|
94
85
|
this.config.basePath = basePath;
|
|
95
86
|
this._defaultApi = null;
|
|
96
87
|
this._publicApi = null;
|
|
97
|
-
this._hiddenApi = null;
|
|
98
88
|
}
|
|
99
89
|
}
|
|
100
90
|
exports.FastCommentsBrowserSDK = FastCommentsBrowserSDK;
|
package/dist/browser.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,mEAAmE;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,mEAAmE;;;;;;;;;;;;;;;;;;;;AAqFnE,oEAEC;AArFD,mEAAmE;AACnE,uDAAqC;AACrC,yDAAuC;AACvC,mDAAwD;AAA/C,wGAAA,aAAa,OAAA;AAEtB,4DAA4D;AAC5D,6CAA6D;AAApD,kGAAA,UAAU,OAAA;AAAE,iGAAA,SAAS,OAAA;AAE9B,sEAAsE;AACtE,sCAAuF;AAA9E,6GAAA,oBAAoB,OAAA;AAAE,mGAAA,UAAU,OAAA;AAAE,iGAAA,QAAQ,OAAA;AAAE,oGAAA,WAAW,OAAA;AAChE,oEAA4E;AAAnE,2IAAA,OAAO,OAAsB;AAEtC,8CAAuD;AAA9C,gHAAA,mBAAmB,OAAA;AAS5B,yBAAyB;AACzB,+CAA6D;AAC7D,qDAAwD;AAOxD,MAAa,sBAAsB;IAKjC,YAAY,SAAuC,EAAE;QAH7C,gBAAW,GAAsB,IAAI,CAAC;QACtC,eAAU,GAAqB,IAAI,CAAC;QAG1C,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,0BAA0B,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,gBAAgB;QACtB,OAAO,IAAI,uBAAa,CAAC;YACvB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YAC1B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,IAAW,UAAU;QACnB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC,WAAW,GAAG,IAAI,iBAAU,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAW,SAAS;QAClB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,IAAI,CAAC,UAAU,GAAG,IAAI,gBAAS,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,MAAc;QACtB,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,QAAgB;QAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;CACF;AAlDD,wDAkDC;AAED,qEAAqE;AACrE,SAAgB,4BAA4B,CAAC,MAAqC;IAChF,OAAO,IAAI,sBAAsB,CAAC,MAAM,CAAC,CAAC;AAC5C,CAAC"}
|
|
@@ -538,7 +538,7 @@ export interface PublicApiInterface {
|
|
|
538
538
|
/**
|
|
539
539
|
*
|
|
540
540
|
* @param {string} tenantId
|
|
541
|
-
* @param {number} [pageSize]
|
|
541
|
+
* @param {number} [pageSize]
|
|
542
542
|
* @param {string} [afterId]
|
|
543
543
|
* @param {boolean} [includeContext]
|
|
544
544
|
* @param {number} [afterCreatedAt]
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/generated/src/apis/index.ts"],"names":[],"mappings":"AAEA,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/generated/src/apis/index.ts"],"names":[],"mappings":"AAEA,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"}
|
|
@@ -17,6 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
/* tslint:disable */
|
|
18
18
|
/* eslint-disable */
|
|
19
19
|
__exportStar(require("./DefaultApi"), exports);
|
|
20
|
-
__exportStar(require("./HiddenApi"), exports);
|
|
21
20
|
__exportStar(require("./PublicApi"), exports);
|
|
22
21
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/generated/src/apis/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+CAA6B;AAC7B,8CAA4B
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/generated/src/apis/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+CAA6B;AAC7B,8CAA4B"}
|