@solibo/solibo-query 1.20.2 → 1.21.0-11ec2cf-1790343347425-SNAPSHOT

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
@@ -1,11 +1,31 @@
1
1
  # @solibo/solibo-query
2
2
 
3
- Framework-agnostic TanStack Query option factories, mutation options, query keys, and utilities for the Solibo SDK.
3
+ Framework-agnostic TanStack Query options, mutation options and query keys for the Solibo Home SDK.
4
+ Solibo Home is the platform for owning and managing homes in Norway. Today it serves housing
5
+ communities (borettslag, sameier and similar) and the boards, owners, residents and property
6
+ managers around them.
4
7
 
5
- For installation, configuration, API usage, and examples, visit the [Solibo SDK documentation](https://sdk.solibo.no).
8
+ You need credentials issued by Solibo: see [Getting credentials](https://developers.solibo.no/authentication#credentials)
9
+ or write to [solibohome@solibo.no](mailto:solibohome@solibo.no).
6
10
 
7
11
  ## Installation
8
12
 
9
13
  ```sh
10
14
  npm install @solibo/solibo-sdk @solibo/solibo-query @tanstack/query-core
11
15
  ```
16
+
17
+ ## First query
18
+
19
+ ```ts
20
+ import { createSoliboClient } from '@solibo/solibo-sdk'
21
+ import { companyByIdQueryOptions } from '@solibo/solibo-query'
22
+ import { QueryClient } from '@tanstack/query-core'
23
+
24
+ // On your server; needs the read, company:list and company:show scopes.
25
+ const sdk = createSoliboClient({ auth: { kind: 'm2m', clientId: 'YOUR_CLIENT_ID', clientSecret: process.env.SOLIBO_CLIENT_SECRET! } })
26
+ const queryClient = new QueryClient()
27
+ const companyId = (await sdk.api.companies.indexCompany({})).items[0].id
28
+ const company = await queryClient.fetchQuery(companyByIdQueryOptions(sdk, { id: companyId }))
29
+ ```
30
+
31
+ Guides, examples and the changelog are at [sdk.solibo.no](https://sdk.solibo.no).
@@ -20,3 +20,13 @@ export declare function publicConversationDocumentQueryOptions(sdk: SoliboClient
20
20
  queryFn: () => Promise<import("@solibo/solibo-sdk").UrlWrapper>;
21
21
  enabled: boolean;
22
22
  };
23
+ /**
24
+ * The signed URL of a public conversation document. The endpoint answers with a redirect unless
25
+ * asked not to, so this always asks for the URL, and shares the cache entry that
26
+ * publicConversationDocumentQueryOptions uses with `redirect: false`.
27
+ */
28
+ export declare function publicConversationDocumentURLQueryOptions(sdk: SoliboClient, params: Omit<Parameters<typeof publicConversationDocumentQueryOptions>[1], "redirect">): {
29
+ queryKey: (string | boolean | readonly ["conversations", "publicDocument", string | number | null | undefined, string | number | null | undefined] | null | undefined)[];
30
+ queryFn: () => Promise<import("@solibo/solibo-sdk").UrlWrapper>;
31
+ enabled: boolean;
32
+ };
@@ -36,4 +36,15 @@ export function publicConversationDocumentQueryOptions(sdk, params) {
36
36
  enabled: !!params.companySlug && !!params.conversationId && !!params.documentId,
37
37
  };
38
38
  }
39
+ /**
40
+ * The signed URL of a public conversation document. The endpoint answers with a redirect unless
41
+ * asked not to, so this always asks for the URL, and shares the cache entry that
42
+ * publicConversationDocumentQueryOptions uses with `redirect: false`.
43
+ */
44
+ export function publicConversationDocumentURLQueryOptions(sdk, params) {
45
+ return publicConversationDocumentQueryOptions(sdk, {
46
+ ...params,
47
+ redirect: false,
48
+ });
49
+ }
39
50
  //# sourceMappingURL=publicConversation.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"publicConversation.js","sourceRoot":"","sources":["../../../../src/api/queries/conversation/publicConversation.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,MAAM,UAAU,8BAA8B,CAC5C,GAAiB,EACjB,MAIC;IAED,OAAO;QACL,QAAQ,EAAE;YACR,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC;YAC9C,MAAM,CAAC,WAAW;YAClB,MAAM,CAAC,MAAM;SACd;QACD,OAAO,EAAE,GAAG,EAAE,CACZ,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,sBAAsB,CAAC;YAC3C,WAAW,EAAE,MAAM,CAAC,WAAY;YAChC,cAAc,EAAE,MAAM,CAAC,cAAe;YACtC,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC;QACJ,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC,MAAM,CAAC,cAAc;KACzD,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,sCAAsC,CACpD,GAAiB,EACjB,MAMC;IAED,OAAO;QACL,QAAQ,EAAE;YACR,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,UAAU,CAAC;YACzE,MAAM,CAAC,WAAW;YAClB,MAAM,CAAC,QAAQ;YACf,MAAM,CAAC,IAAI;YACX,MAAM,CAAC,MAAM;YACb,GAAG,iBAAiB,CAAC,MAAM,CAAC;SAC7B;QACD,OAAO,EAAE,GAAG,EAAE,CACZ,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,8BAA8B,CAAC;YACnD,WAAW,EAAE,MAAM,CAAC,WAAY;YAChC,cAAc,EAAE,MAAM,CAAC,cAAe;YACtC,UAAU,EAAE,MAAM,CAAC,UAAW;YAC9B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,GAAG,qBAAqB,CAAC,MAAM,CAAC;YAChC,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC;QACJ,OAAO,EACL,CAAC,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC,MAAM,CAAC,cAAc,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU;KACzE,CAAC;AACJ,CAAC","sourcesContent":["import { Id, SoliboClient } from \"@solibo/solibo-sdk\";\nimport {\n type ImageTransformOptions,\n imageTransformKey,\n imageTransformOptions,\n} from \"../../imageTransformOptions.js\";\nimport { conversationKeys } from \"./conversations.js\";\nexport function publicConversationQueryOptions(\n sdk: SoliboClient,\n params: {\n companySlug?: string;\n conversationId?: Id | null | undefined;\n fields?: string;\n },\n) {\n return {\n queryKey: [\n conversationKeys.public(params.conversationId),\n params.companySlug,\n params.fields,\n ],\n queryFn: () =>\n sdk.api.conversations.showConversationPublic({\n companySlug: params.companySlug!,\n conversationId: params.conversationId!,\n fields: params.fields,\n }),\n enabled: !!params.companySlug && !!params.conversationId,\n };\n}\nexport function publicConversationDocumentQueryOptions(\n sdk: SoliboClient,\n params: ImageTransformOptions & {\n companySlug?: string;\n conversationId?: Id | null | undefined;\n documentId?: Id | null | undefined;\n redirect?: boolean | null;\n fields?: string;\n },\n) {\n return {\n queryKey: [\n conversationKeys.publicDocument(params.conversationId, params.documentId),\n params.companySlug,\n params.redirect,\n params.size,\n params.fields,\n ...imageTransformKey(params),\n ],\n queryFn: () =>\n sdk.api.conversations.showDocumentPublicConversation({\n companySlug: params.companySlug!,\n conversationId: params.conversationId!,\n documentId: params.documentId!,\n redirect: params.redirect,\n ...imageTransformOptions(params),\n fields: params.fields,\n }),\n enabled:\n !!params.companySlug && !!params.conversationId && !!params.documentId,\n };\n}\n"]}
1
+ {"version":3,"file":"publicConversation.js","sourceRoot":"","sources":["../../../../src/api/queries/conversation/publicConversation.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,MAAM,UAAU,8BAA8B,CAC5C,GAAiB,EACjB,MAIC;IAED,OAAO;QACL,QAAQ,EAAE;YACR,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC;YAC9C,MAAM,CAAC,WAAW;YAClB,MAAM,CAAC,MAAM;SACd;QACD,OAAO,EAAE,GAAG,EAAE,CACZ,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,sBAAsB,CAAC;YAC3C,WAAW,EAAE,MAAM,CAAC,WAAY;YAChC,cAAc,EAAE,MAAM,CAAC,cAAe;YACtC,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC;QACJ,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC,MAAM,CAAC,cAAc;KACzD,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,sCAAsC,CACpD,GAAiB,EACjB,MAMC;IAED,OAAO;QACL,QAAQ,EAAE;YACR,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,UAAU,CAAC;YACzE,MAAM,CAAC,WAAW;YAClB,MAAM,CAAC,QAAQ;YACf,MAAM,CAAC,IAAI;YACX,MAAM,CAAC,MAAM;YACb,GAAG,iBAAiB,CAAC,MAAM,CAAC;SAC7B;QACD,OAAO,EAAE,GAAG,EAAE,CACZ,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,8BAA8B,CAAC;YACnD,WAAW,EAAE,MAAM,CAAC,WAAY;YAChC,cAAc,EAAE,MAAM,CAAC,cAAe;YACtC,UAAU,EAAE,MAAM,CAAC,UAAW;YAC9B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,GAAG,qBAAqB,CAAC,MAAM,CAAC;YAChC,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC;QACJ,OAAO,EACL,CAAC,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC,MAAM,CAAC,cAAc,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU;KACzE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yCAAyC,CACvD,GAAiB,EACjB,MAGC;IAED,OAAO,sCAAsC,CAAC,GAAG,EAAE;QACjD,GAAG,MAAM;QACT,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { Id, SoliboClient } from \"@solibo/solibo-sdk\";\nimport {\n type ImageTransformOptions,\n imageTransformKey,\n imageTransformOptions,\n} from \"../../imageTransformOptions.js\";\nimport { conversationKeys } from \"./conversations.js\";\nexport function publicConversationQueryOptions(\n sdk: SoliboClient,\n params: {\n companySlug?: string;\n conversationId?: Id | null | undefined;\n fields?: string;\n },\n) {\n return {\n queryKey: [\n conversationKeys.public(params.conversationId),\n params.companySlug,\n params.fields,\n ],\n queryFn: () =>\n sdk.api.conversations.showConversationPublic({\n companySlug: params.companySlug!,\n conversationId: params.conversationId!,\n fields: params.fields,\n }),\n enabled: !!params.companySlug && !!params.conversationId,\n };\n}\nexport function publicConversationDocumentQueryOptions(\n sdk: SoliboClient,\n params: ImageTransformOptions & {\n companySlug?: string;\n conversationId?: Id | null | undefined;\n documentId?: Id | null | undefined;\n redirect?: boolean | null;\n fields?: string;\n },\n) {\n return {\n queryKey: [\n conversationKeys.publicDocument(params.conversationId, params.documentId),\n params.companySlug,\n params.redirect,\n params.size,\n params.fields,\n ...imageTransformKey(params),\n ],\n queryFn: () =>\n sdk.api.conversations.showDocumentPublicConversation({\n companySlug: params.companySlug!,\n conversationId: params.conversationId!,\n documentId: params.documentId!,\n redirect: params.redirect,\n ...imageTransformOptions(params),\n fields: params.fields,\n }),\n enabled:\n !!params.companySlug && !!params.conversationId && !!params.documentId,\n };\n}\n\n/**\n * The signed URL of a public conversation document. The endpoint answers with a redirect unless\n * asked not to, so this always asks for the URL, and shares the cache entry that\n * publicConversationDocumentQueryOptions uses with `redirect: false`.\n */\nexport function publicConversationDocumentURLQueryOptions(\n sdk: SoliboClient,\n params: Omit<\n Parameters<typeof publicConversationDocumentQueryOptions>[1],\n \"redirect\"\n >,\n) {\n return publicConversationDocumentQueryOptions(sdk, {\n ...params,\n redirect: false,\n });\n}\n"]}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@solibo/solibo-query",
3
- "version": "1.20.2",
4
- "description": "Framework-agnostic TanStack Query options for Solibo SDK",
3
+ "version": "1.21.0-11ec2cf-1790343347425-SNAPSHOT",
4
+ "description": "Framework-agnostic TanStack Query options for the Solibo Home SDK. Solibo Home is the platform for owning and managing homes in Norway.",
5
5
  "homepage": "https://sdk.solibo.no",
6
6
  "repository": {
7
7
  "type": "git",
@@ -14,6 +14,11 @@
14
14
  "license": "MIT",
15
15
  "keywords": [
16
16
  "solibo",
17
+ "solibo-home",
18
+ "housing",
19
+ "norway",
20
+ "borettslag",
21
+ "sameie",
17
22
  "tanstack-query",
18
23
  "typescript"
19
24
  ],
@@ -35,7 +40,7 @@
35
40
  "buffer": "^6.0.3",
36
41
  "hash-wasm": "^4.12.0",
37
42
  "mime-types": "^3.0.2",
38
- "@solibo/solibo-sdk": "1.20.2"
43
+ "@solibo/solibo-sdk": "1.21.0-11ec2cf-1790343347425-SNAPSHOT"
39
44
  },
40
45
  "devDependencies": {
41
46
  "@eslint/js": "^10.0.1",