Cgerman/client cache

package.json

@@ -11,6 +11,7 @@
  "lint": "eslint '**/*.{ts,tsx}'",
  "typecheck": "run-p --silent typecheck:*",
  "typecheck:components": "npm run typecheck --prefix packages/saved-views-react",
+ "typecheck:client": "npm run typecheck --prefix packages/saved-views-client",
  "typecheck:backend": "npm run typecheck --prefix packages/test-app-backend",
  "typecheck:frontend": "npm run typecheck --prefix packages/test-app-frontend",
  "release": "ts-node --esm scripts/release.ts"

packages/saved-views-client/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+ "rules": {
+ "no-console": "warn"
+ }
+}

packages/saved-views-client/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this package will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased](https://github.com/iTwin/saved-views-react/tree/HEAD/packages/saved-views-client)
+
+Initial package release.

packages/saved-views-client/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright © 2023 Bentley Systems, Incorporated. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/saved-views-client/README.md

@@ -0,0 +1,31 @@
+# @itwin/saved-views-client
+
+## About
+
+## Installation
+
+```shell
+npm install @itwin/saved-views-client
+```
+
+## Example
+
+```TypeScript
+import { ITwinSavedViewsClient } from "@itwin/saved-views-client";
+
+const iTwinSavedViewsClient = new ITwinSavedViewsClient({
+ getAccessToken: () => { return token; };
+});
+
+const res = await iTwinSavedViewsClient.getSavedViewMinimal({
+ savedViewId:"ID",
+})
+```
+
+## Contributing
+
+We welcome contributions to make this package better. You can submit feature requests or report bugs by creating an [issue](https://github.com/iTwin/saved-views-react/issues).
+
+---
+
+Copyright © Bentley Systems, Incorporated. All rights reserved. See [LICENSE.md](./LICENSE.md) for license terms and full copyright notice.

packages/saved-views-client/package.json

@@ -0,0 +1,54 @@
+{
+ "name": "@itwin/saved-views-client",
+ "version": "0.1.0",
+ "license": "MIT",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/iTwin/saved-views-react.git",
+ "directory": "packages/saved-views-client"
+ },
+ "homepage": "https://github.com/iTwin/saved-views-react/packages/saved-views-client",
+ "author": {
+ "name": "Bentley Systems, Inc.",
+ "url": "https://www.bentley.com"
+ },
+ "types": "./lib/cjs/index.d.ts",
+ "exports": {
+ ".": {
+ "import": {
+ "types": "./lib/esm/index.d.ts",
+ "default": "./lib/esm/index.js"
+ },
+ "require": {
+ "types": "./lib/cjs/index.d.ts",
+ "default": "./lib/cjs/index.js"
+ }
+ }
+ },
+ "files": [
+ "./lib",
+ "./public"
+ ],
+ "scripts": {
+ "build": "run-p build:**",
+ "build:transpile:esm": "tsc --project ./tsconfig.build.json",
+ "test": "vitest",
+ "test:cover": "vitest run --coverage",
+ "test:watch": "vitest watch",
+ "typecheck": "tsc --noEmit"
+ },
+ "devDependencies": {
+ "@types/uuid": "^9.0.2",
+ "@vitest/coverage-v8": "^0.33.0",
+ "happy-dom": "^10.5.2",
+ "npm-run-all": "^4.1.5",
+ "typescript": "^5.1.6",
+ "vite": "^4.4.7",
+ "vitest": "^0.33.0"
+ },
+ "dependencies": {
+ "base64-arraybuffer": "^1.0.2",
+ "class-validator": "^0.14.0",
+ "uuid": "^9.0.0"
+ }
+}

packages/saved-views-client/publish.yaml

@@ -0,0 +1,81 @@
+trigger:
+ tags:
+ include:
+ - v*.*.*
+
+pr: none
+
+variables:
+ - name: packageName
+ value: "saved-views-client"
+ - name: packageVersion
+ value: ${{ replace(variables['Build.SourceBranchName'], 'v', '') }}
+ - name: tarballName
+ value: itwin-$(packageName)-$(packageVersion).tgz
+
+resources:
+ repositories:
+ - repository: templates
+ type: git
+ name: iModelTechnologies/imodeljs-build-pipeline-scripts
+
+stages:
+ - stage: build
+ displayName: Build
+ jobs:
+ - job: Build
+ steps:
+ - checkout: self
+ clean: true
+ fetchDepth: 1
+
+ - task: NodeTool@0
+ displayName: Use Node.js 18.x
+ inputs:
+ versionSpec: 18.x
+
+ - task: CmdLine@2
+ displayName: Install pnpm
+ inputs:
+ script: npm install -g pnpm
+
+ - task: CmdLine@2
+ displayName: Audit
+ inputs:
+ script: pnpm audit --audit-level=high
+
+ - task: CmdLine@2
+ displayName: Install dependencies
+ inputs:
+ script: pnpm install --filter $(packageName)
+
+ - task: CmdLine@2
+ displayName: Build package
+ inputs:
+ script: npm run build
+ workingDirectory: packages/$(packageName)/
+
+ - task: CmdLine@2
+ displayName: Run unit tests
+ inputs:
+ script: npm run test:cover
+ workingDirectory: packages/$(packageName)/
+
+ - task: CmdLine@2
+ displayName: Pack package files
+ inputs:
+ script: pnpm pack
+ workingDirectory: packages/$(packageName)/
+
+ - publish: packages/$(packageName)/$(tarballName)
+ displayName: Publish package artifact
+ artifact: published-package
+
+ - stage: publish
+ dependsOn: build
+ displayName: Publish
+ jobs:
+ - template: templates/npmjs-publish-deployment.yaml@templates
+ parameters:
+ path: $(tarballName)
+ artifactName: published-package

packages/saved-views-client/src/client/ApiUtils.ts

@@ -0,0 +1,44 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+
+export interface CallITwinApiParams {
+ url: string;
+ method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+ getAccessToken: () => Promise<string>;
+ body?: object | undefined;
+ headers?: Record<string, string> | undefined;
+ signal?: AbortSignal | undefined;
+}
+
+export async function callITwinApi(args: CallITwinApiParams): Promise<Record<string, unknown>> {
+ const response = await fetch(args.url, {
+ method: args.method,
+ body: args.body && JSON.stringify(args.body),
+ headers: {
+ ...args.headers,
+ Authorization: await args.getAccessToken(),
+ },
+ signal: args.signal,
+ });
+
+ if (!response.ok) {
+ await throwBadResponseCodeError(response, "iTwin API request failed.");
+ }
+
+ return response.json();
+}
+
+async function throwBadResponseCodeError(response: Response, errorMessage: string): Promise<never> {
+ let error: unknown;
+ try {
+ error = (await response.json()).error;
+ } catch {
+ throw new Error(
+ `${errorMessage} Unexpected response status code: ${response.status} ${response.statusText}.`,
+ );
+ }
+
+ throw error;
+}