New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@laserfiche/lf-api-client-core

Package Overview
Dependencies
Maintainers
0
Versions
132
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@laserfiche/lf-api-client-core - npm Package Compare versions

Comparing version

1.1.14--preview-11466058920
to
1.1.14--preview-11483249762

8

dist/lib/APIServer/TokenClient.d.ts

@@ -6,5 +6,5 @@ import { CreateConnectionRequest } from './CreateConnectionRequest.js';

* Gets the Laserfiche Self-Hosted access token
* @param repositoryId Repository name
* @param body Request body that contains username, password and grant type
* @return Create an access token successfully.
* @param repositoryId - Repository name
* @param body - Request body that contains username, password and grant type
* @returns Create an access token successfully.
*/

@@ -18,3 +18,3 @@ createAccessToken(repositoryId: string, body: CreateConnectionRequest): Promise<SessionKeyInfo>;

* Constructor for a TokenClient used to interact with the Laserfiche Self-Hosted token endpoint.
* @param baseUrl APIServer Base Url e.g. https://{APIServerName}/LFRepositoryAPI
* @param baseUrl - APIServer Base Url e.g. https://\{APIServerName\}/LFRepositoryAPI
*/

@@ -21,0 +21,0 @@ constructor(baseUrl: string);

2

dist/lib/APIServer/TokenClient.js

@@ -15,3 +15,3 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {

* Constructor for a TokenClient used to interact with the Laserfiche Self-Hosted token endpoint.
* @param baseUrl APIServer Base Url e.g. https://{APIServerName}/LFRepositoryAPI
* @param baseUrl - APIServer Base Url e.g. https://\{APIServerName\}/LFRepositoryAPI
*/

@@ -18,0 +18,0 @@ constructor(baseUrl) {

4

dist/lib/HttpError.d.ts

@@ -12,6 +12,6 @@ /**

* Constructor
* @param message The error message
* @param status The HTTP status code
* @param message - The error message
* @param status - The HTTP status code
*/
constructor(message: string, status: number);
}

4

dist/lib/HttpError.js

@@ -13,4 +13,4 @@ // Copyright Laserfiche.

* Constructor
* @param message The error message
* @param status The HTTP status code
* @param message - The error message
* @param status - The HTTP status code
*/

@@ -17,0 +17,0 @@ constructor(message, status) {

10

dist/lib/HttpHandlers/HttpRequestHandler.d.ts

@@ -5,4 +5,4 @@ import { BeforeFetchResult } from './BeforeFetchResult.js';

* Called to prepare the request to the API service.
* @param url The HTTP url
* @param request The HTTP request
* @param url - The HTTP url
* @param request - The HTTP request
*/

@@ -12,5 +12,5 @@ beforeFetchRequestAsync: (url: string, request: RequestInit) => Promise<BeforeFetchResult>;

* Called to handle the response from the API service.
* @param url The HTTP url
* @param response The HTTP response
* @param request The HTTP request
* @param url - The HTTP url
* @param response - The HTTP response
* @param request - The HTTP request
* @returns true if the request should be retried.

@@ -17,0 +17,0 @@ */

16

dist/lib/HttpHandlers/OAuthClientCredentialsHandler.d.ts

@@ -12,5 +12,5 @@ import { HttpRequestHandler } from './HttpRequestHandler.js';

* Constructor
* @param servicePrincipalKey The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey The access key exported from the Laserfiche Developer Console.
* @param scope Specifies the requested scopes for the authorization request. Scopes are case-sensitive and space-delimited.
* @param servicePrincipalKey - The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey - The access key exported from the Laserfiche Developer Console.
* @param scope - Specifies the requested scopes for the authorization request. Scopes are case-sensitive and space-delimited.
*/

@@ -20,4 +20,4 @@ constructor(servicePrincipalKey: string, accessKey: AccessKey, scope?: string);

* Called to prepare the request to the API service.
* @param url The HTTP url
* @param request The HTTP request
* @param url - The HTTP url
* @param request - The HTTP request
*/

@@ -27,5 +27,5 @@ beforeFetchRequestAsync(url: string, request: RequestInit): Promise<BeforeFetchResult>;

* Called to handle the response from the API service.
* @param url The HTTP url
* @param response The HTTP response
* @param request The HTTP request
* @param url - The HTTP url
* @param response - The HTTP response
* @param request - The HTTP request
* @returns true if the request should be retried.

@@ -32,0 +32,0 @@ */

16

dist/lib/HttpHandlers/OAuthClientCredentialsHandler.js

@@ -14,5 +14,5 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {

* Constructor
* @param servicePrincipalKey The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey The access key exported from the Laserfiche Developer Console.
* @param scope Specifies the requested scopes for the authorization request. Scopes are case-sensitive and space-delimited.
* @param servicePrincipalKey - The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey - The access key exported from the Laserfiche Developer Console.
* @param scope - Specifies the requested scopes for the authorization request. Scopes are case-sensitive and space-delimited.
*/

@@ -29,4 +29,4 @@ constructor(servicePrincipalKey, accessKey, scope) {

* Called to prepare the request to the API service.
* @param url The HTTP url
* @param request The HTTP request
* @param url - The HTTP url
* @param request - The HTTP request
*/

@@ -51,5 +51,5 @@ beforeFetchRequestAsync(url, request) {

* Called to handle the response from the API service.
* @param url The HTTP url
* @param response The HTTP response
* @param request The HTTP request
* @param url - The HTTP url
* @param response - The HTTP response
* @param request - The HTTP request
* @returns true if the request should be retried.

@@ -56,0 +56,0 @@ */

16

dist/lib/HttpHandlers/OAuthClientCustomTokenCredentialsHandler.d.ts

@@ -9,5 +9,5 @@ import { HttpRequestHandler } from './HttpRequestHandler.js';

* Constructor
* @param servicePrincipalKey The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey The access key exported from the Laserfiche Developer Console.
* @param scope Specifies the requested scopes for the authorization request. Scopes are case-sensitive and space-delimited.
* @param servicePrincipalKey - The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey - The access key exported from the Laserfiche Developer Console.
* @param scope - Specifies the requested scopes for the authorization request. Scopes are case-sensitive and space-delimited.
*/

@@ -17,4 +17,4 @@ constructor(getAccessTokenAsync: () => Promise<GetAccessTokenResponse>);

* Called to prepare the request to the API service.
* @param url The HTTP url
* @param request The HTTP request
* @param url - The HTTP url
* @param request - The HTTP request
*/

@@ -24,5 +24,5 @@ beforeFetchRequestAsync(url: string, request: RequestInit): Promise<BeforeFetchResult>;

* Called to handle the response from the API service.
* @param url The HTTP url
* @param response The HTTP response
* @param request The HTTP request
* @param url - The HTTP url
* @param response - The HTTP response
* @param request - The HTTP request
* @returns true if the request should be retried.

@@ -29,0 +29,0 @@ */

16

dist/lib/HttpHandlers/OAuthClientCustomTokenCredentialsHandler.js

@@ -14,5 +14,5 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {

* Constructor
* @param servicePrincipalKey The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey The access key exported from the Laserfiche Developer Console.
* @param scope Specifies the requested scopes for the authorization request. Scopes are case-sensitive and space-delimited.
* @param servicePrincipalKey - The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey - The access key exported from the Laserfiche Developer Console.
* @param scope - Specifies the requested scopes for the authorization request. Scopes are case-sensitive and space-delimited.
*/

@@ -24,4 +24,4 @@ constructor(getAccessTokenAsync) {

* Called to prepare the request to the API service.
* @param url The HTTP url
* @param request The HTTP request
* @param url - The HTTP url
* @param request - The HTTP request
*/

@@ -62,5 +62,5 @@ beforeFetchRequestAsync(url, request) {

* Called to handle the response from the API service.
* @param url The HTTP url
* @param response The HTTP response
* @param request The HTTP request
* @param url - The HTTP url
* @param response - The HTTP response
* @param request - The HTTP request
* @returns true if the request should be retried.

@@ -67,0 +67,0 @@ */

20

dist/lib/HttpHandlers/UsernamePasswordHandler.d.ts

@@ -13,7 +13,7 @@ import { ITokenClient } from '../APIServer/TokenClient.js';

*
* @param repositoryId Repository name
* @param username The username used with "password" grant type.
* @param password The password used with "password" grant type.
* @param baseUrl APIServer Base Url e.g. https://{APIServerName}/LFRepositoryAPI
* @param client OPTIONAL
* @param repositoryId - Repository name
* @param username - The username used with "password" grant type.
* @param password - The password used with "password" grant type.
* @param baseUrl - APIServer Base Url e.g. https://{APIServerName}/LFRepositoryAPI
* @param client - OPTIONAL
*/

@@ -23,4 +23,4 @@ constructor(repositoryId: string, username: string, password: string, baseUrl: string, client?: ITokenClient);

* Called to prepare the request to the API service.
* @param url The HTTP url
* @param request The HTTP request
* @param url - The HTTP url
* @param request - The HTTP request
*/

@@ -30,5 +30,5 @@ beforeFetchRequestAsync(url: string, request: RequestInit): Promise<BeforeFetchResult>;

* Called to handle the response from the API service.
* @param url The HTTP url
* @param response The HTTP response
* @param request The HTTP request
* @param url - The HTTP url
* @param response - The HTTP response
* @param request - The HTTP request
* @returns true if the request should be retried.

@@ -35,0 +35,0 @@ */

20

dist/lib/HttpHandlers/UsernamePasswordHandler.js

@@ -16,7 +16,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {

*
* @param repositoryId Repository name
* @param username The username used with "password" grant type.
* @param password The password used with "password" grant type.
* @param baseUrl APIServer Base Url e.g. https://{APIServerName}/LFRepositoryAPI
* @param client OPTIONAL
* @param repositoryId - Repository name
* @param username - The username used with "password" grant type.
* @param password - The password used with "password" grant type.
* @param baseUrl - APIServer Base Url e.g. https://{APIServerName}/LFRepositoryAPI
* @param client - OPTIONAL
*/

@@ -41,4 +41,4 @@ constructor(repositoryId, username, password, baseUrl, client) {

* Called to prepare the request to the API service.
* @param url The HTTP url
* @param request The HTTP request
* @param url - The HTTP url
* @param request - The HTTP request
*/

@@ -69,5 +69,5 @@ beforeFetchRequestAsync(url, request) {

* Called to handle the response from the API service.
* @param url The HTTP url
* @param response The HTTP response
* @param request The HTTP request
* @param url - The HTTP url
* @param response - The HTTP response
* @param request - The HTTP request
* @returns true if the request should be retried.

@@ -74,0 +74,0 @@ */

8

dist/lib/OAuth/AccessKey.d.ts

@@ -31,8 +31,8 @@ import { JWK } from './JWK.js';

* Create OAuth 2.0 client_credentials Authorization JWT that can be used with Laserfiche Cloud Token endpoint to request an Access Token.
* @param servicePrincipalKey The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey AccessKey JSON object or base-64 encoded AccessKey exported from the Laserfiche Developer Console.
* @param expireInSeconds The expiration time in seconds for the authorization JWT with a default value of 3600 seconds. Set it to 0 if the JWT never expires.
* @param scope (optional) The requested scopes. Applies only when the generated key is used as a HTTP Basic Authorization password. Scopes are case-sensitive and space-delimited. (Ex/ 'repository.Read repository.Write')
* @param servicePrincipalKey - The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey - AccessKey JSON object or base-64 encoded AccessKey exported from the Laserfiche Developer Console.
* @param expireInSeconds - The expiration time in seconds for the authorization JWT with a default value of 3600 seconds. Set it to 0 if the JWT never expires.
* @param scope - (optional) The requested scopes. Applies only when the generated key is used as a HTTP Basic Authorization password. Scopes are case-sensitive and space-delimited. (Ex/ 'repository.Read repository.Write')
* @returns Authorization JWT.
*/
export declare function createClientCredentialsAuthorizationJwt(servicePrincipalKey: string, accessKey: AccessKey | string, expireInSeconds?: number, scope?: string): string;

8

dist/lib/OAuth/AccessKey.js

@@ -20,6 +20,6 @@ // Copyright Laserfiche.

* Create OAuth 2.0 client_credentials Authorization JWT that can be used with Laserfiche Cloud Token endpoint to request an Access Token.
* @param servicePrincipalKey The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey AccessKey JSON object or base-64 encoded AccessKey exported from the Laserfiche Developer Console.
* @param expireInSeconds The expiration time in seconds for the authorization JWT with a default value of 3600 seconds. Set it to 0 if the JWT never expires.
* @param scope (optional) The requested scopes. Applies only when the generated key is used as a HTTP Basic Authorization password. Scopes are case-sensitive and space-delimited. (Ex/ 'repository.Read repository.Write')
* @param servicePrincipalKey - The service principal key created for the service principal from the Laserfiche Account Administration.
* @param accessKey - AccessKey JSON object or base-64 encoded AccessKey exported from the Laserfiche Developer Console.
* @param expireInSeconds - The expiration time in seconds for the authorization JWT with a default value of 3600 seconds. Set it to 0 if the JWT never expires.
* @param scope - (optional) The requested scopes. Applies only when the generated key is used as a HTTP Basic Authorization password. Scopes are case-sensitive and space-delimited. (Ex/ 'repository.Read repository.Write')
* @returns Authorization JWT.

@@ -26,0 +26,0 @@ */

50

dist/lib/OAuth/TokenClient.d.ts

@@ -9,5 +9,5 @@ import { AccessKey } from './AccessKey.js';

* Gets an OAuth access token given a Laserfiche cloud service principal key and an OAuth service application access key.
* @param servicePrincipalKey Laserfiche cloud service principal key
* @param accessKey OAuth service application access key
* @param scope OPTIONAL The requested space-delimited scopes for the access token.
* @param servicePrincipalKey - Laserfiche cloud service principal key
* @param accessKey - OAuth service application access key
* @param scope - OPTIONAL The requested space-delimited scopes for the access token.
*/

@@ -17,8 +17,8 @@ getAccessTokenFromServicePrincipal(servicePrincipalKey: string, accessKey: AccessKey, scope?: string): Promise<GetAccessTokenResponse>;

* Gets an OAuth access token given an OAuth code
* @param code Authorization code
* @param redirect_uri Authorization endpoint redirect uri
* @param client_id OAuth application client id
* @param client_secret OPTIONAL OAuth application client secret. Required for web apps.
* @param code_verifier OPTIONAL PKCE code verifier. Required for SPA apps.
* @param scope OPTIONAL The requested space-delimited scopes for the access token.
* @param code - Authorization code
* @param redirect_uri - Authorization endpoint redirect uri
* @param client_id - OAuth application client id
* @param client_secret - OPTIONAL OAuth application client secret. Required for web apps.
* @param code_verifier - OPTIONAL PKCE code verifier. Required for SPA apps.
* @param scope - OPTIONAL The requested space-delimited scopes for the access token.
*/

@@ -28,5 +28,5 @@ getAccessTokenFromCode(code: string, redirect_uri: string, client_id: string, client_secret?: string, code_verifier?: string, scope?: string): Promise<GetAccessTokenResponse>;

* Gets a refreshed access token given a refresh token
* @param refresh_token Refresh token
* @param client_id OAuth application client id
* @param client_secret OPTIONAL OAuth application client secret. Required for web apps.
* @param refresh_token - Refresh token
* @param client_id - OAuth application client id
* @param client_secret - OPTIONAL OAuth application client secret. Required for web apps.
*/

@@ -45,3 +45,3 @@ refreshAccessToken(refresh_token: string, client_id: string, client_secret?: string): Promise<GetAccessTokenResponse>;

* Constructor for a TokenClient used to interact with the Laserfiche Cloud OAuth 2.0 token endpoint.
* @param regionalDomain regional specific host, such as 'laserfiche.com', or 'eu.laserfiche.com'
* @param regionalDomain - regional specific host, such as 'laserfiche.com', or 'eu.laserfiche.com'
*/

@@ -51,5 +51,5 @@ constructor(regionalDomain: string);

* Gets a refreshed access token given a refresh token
* @param refresh_token Refresh token
* @param client_id OAuth application client id
* @param client_secret OPTIONAL OAuth application client secret. Required for web apps.
* @param refresh_token - Refresh token
* @param client_id - OAuth application client id
* @param client_secret - OPTIONAL OAuth application client secret. Required for web apps.
*/

@@ -59,8 +59,8 @@ refreshAccessToken(refresh_token: string, client_id: string, client_secret?: string): Promise<GetAccessTokenResponse>;

* Gets an OAuth access token given an OAuth code
* @param code Authorization code
* @param redirect_uri Authorization endpoint redirect uri
* @param client_id OAuth application client id
* @param client_secret OPTIONAL OAuth application client secret. Required for web apps.
* @param code_verifier OPTIONAL PKCE code verifier. Required for SPA apps.
* @param scope OPTIONAL The requested space-delimited scopes for the access token.
* @param code - Authorization code
* @param redirect_uri - Authorization endpoint redirect uri
* @param client_id - OAuth application client id
* @param client_secret - OPTIONAL OAuth application client secret. Required for web apps.
* @param code_verifier - OPTIONAL PKCE code verifier. Required for SPA apps.
* @param scope - OPTIONAL The requested space-delimited scopes for the access token.
*/

@@ -70,5 +70,5 @@ getAccessTokenFromCode(code: string, redirect_uri: string, client_id: string, client_secret?: string, code_verifier?: string, scope?: string): Promise<GetAccessTokenResponse>;

* Gets an OAuth access token given a Laserfiche cloud service principal key and an OAuth service application access key.
* @param servicePrincipalKey Laserfiche cloud service principal key
* @param accessKey OAuth service application access key
* @param scope OPTIONAL The requested space-delimited scopes for the access token.
* @param servicePrincipalKey - Laserfiche cloud service principal key
* @param accessKey - OAuth service application access key
* @param scope - OPTIONAL The requested space-delimited scopes for the access token.
*/

@@ -75,0 +75,0 @@ getAccessTokenFromServicePrincipal(servicePrincipalKey: string, accessKey: AccessKey, scope?: string): Promise<GetAccessTokenResponse>;

26

dist/lib/OAuth/TokenClient.js

@@ -24,3 +24,3 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {

* Constructor for a TokenClient used to interact with the Laserfiche Cloud OAuth 2.0 token endpoint.
* @param regionalDomain regional specific host, such as 'laserfiche.com', or 'eu.laserfiche.com'
* @param regionalDomain - regional specific host, such as 'laserfiche.com', or 'eu.laserfiche.com'
*/

@@ -35,5 +35,5 @@ constructor(regionalDomain) {

* Gets a refreshed access token given a refresh token
* @param refresh_token Refresh token
* @param client_id OAuth application client id
* @param client_secret OPTIONAL OAuth application client secret. Required for web apps.
* @param refresh_token - Refresh token
* @param client_id - OAuth application client id
* @param client_secret - OPTIONAL OAuth application client secret. Required for web apps.
*/

@@ -63,8 +63,8 @@ refreshAccessToken(refresh_token, client_id, client_secret) {

* Gets an OAuth access token given an OAuth code
* @param code Authorization code
* @param redirect_uri Authorization endpoint redirect uri
* @param client_id OAuth application client id
* @param client_secret OPTIONAL OAuth application client secret. Required for web apps.
* @param code_verifier OPTIONAL PKCE code verifier. Required for SPA apps.
* @param scope OPTIONAL The requested space-delimited scopes for the access token.
* @param code - Authorization code
* @param redirect_uri - Authorization endpoint redirect uri
* @param client_id - OAuth application client id
* @param client_secret - OPTIONAL OAuth application client secret. Required for web apps.
* @param code_verifier - OPTIONAL PKCE code verifier. Required for SPA apps.
* @param scope - OPTIONAL The requested space-delimited scopes for the access token.
*/

@@ -94,5 +94,5 @@ getAccessTokenFromCode(code, redirect_uri, client_id, client_secret, code_verifier, scope) {

* Gets an OAuth access token given a Laserfiche cloud service principal key and an OAuth service application access key.
* @param servicePrincipalKey Laserfiche cloud service principal key
* @param accessKey OAuth service application access key
* @param scope OPTIONAL The requested space-delimited scopes for the access token.
* @param servicePrincipalKey - Laserfiche cloud service principal key
* @param accessKey - OAuth service application access key
* @param scope - OPTIONAL The requested space-delimited scopes for the access token.
*/

@@ -99,0 +99,0 @@ getAccessTokenFromServicePrincipal(servicePrincipalKey, accessKey, scope) {

6

dist/lib/utils/DomainUtils.d.ts

@@ -12,3 +12,3 @@ /**

* Returns region-specific Laserfiche Cloud endpoints
* @param regionalDomain regional specific host, such as 'laserfiche.com', or 'eu.laserfiche.com'
* @param regionalDomain - regional specific host, such as 'laserfiche.com', or 'eu.laserfiche.com'
* @returns

@@ -37,3 +37,3 @@ * @example

* Creates the Laserfiche repository API base address
* @param regionDomain Laserfiche Cloud Regional Domain
* @param regionDomain - Laserfiche Cloud Regional Domain
* @returns Laserfiche repository API base address

@@ -48,3 +48,3 @@ * @example

* Creates the Laserfiche Oauth Token endpoint
* @param regionDomain Laserfiche Cloud Regional Domain
* @param regionDomain - Laserfiche Cloud Regional Domain
* @returns Laserfiche Oauth Token endpoint

@@ -51,0 +51,0 @@ * @example

6

dist/lib/utils/DomainUtils.js
/**
* Returns region-specific Laserfiche Cloud endpoints
* @param regionalDomain regional specific host, such as 'laserfiche.com', or 'eu.laserfiche.com'
* @param regionalDomain - regional specific host, such as 'laserfiche.com', or 'eu.laserfiche.com'
* @returns

@@ -36,3 +36,3 @@ * @example

* Creates the Laserfiche repository API base address
* @param regionDomain Laserfiche Cloud Regional Domain
* @param regionDomain - Laserfiche Cloud Regional Domain
* @returns Laserfiche repository API base address

@@ -51,3 +51,3 @@ * @example

* Creates the Laserfiche Oauth Token endpoint
* @param regionDomain Laserfiche Cloud Regional Domain
* @param regionDomain - Laserfiche Cloud Regional Domain
* @returns Laserfiche Oauth Token endpoint

@@ -54,0 +54,0 @@ * @example

2

package.json
{
"name": "@laserfiche/lf-api-client-core",
"version": "1.1.14--preview-11466058920",
"version": "1.1.14--preview-11483249762",
"description": "",

@@ -5,0 +5,0 @@ "main": "dist/index.js",