@api-client/core 0.20.10 → 0.21.1

package/TESTING_SETUP.md

@@ -1,198 +0,0 @@
-# Testing Setup Guide
-
-## Overview
-
-This project uses a sophisticated dual-testing approach with:
-
-- **Japa** for Node.js unit tests (server-side)
-- **Web Test Runner** for browser tests (client-side)
-
-## Test Structure
-
-```text
-├── test/                    # Browser tests (Web Test Runner)
-│   ├── **/*.browser.test.ts # Browser-specific tests
-│   ├── **/*.spec.ts         # Browser test specs
-│   └── env.ts               # Test environment configuration
-├── tests/                   # Node.js tests (Japa)
-│   └── unit/                # Unit tests for server-side code
-│       └── **/*.spec.ts     # Node.js test specs
-└── bin/
-    ├── test.ts              # Japa test runner
-    ├── test-web.ts          # Web Test Runner launcher
-    └── plugins/             # Custom test plugins
-```
-
-## Available Test Commands
-
-### Node.js Tests
-
-```bash
-npm run test:node           # Run all Node.js tests
-npm run test:node:coverage  # Run with coverage
-```
-
-### Browser Tests
-
-```bash
-npm run test:browser        # Run all browser tests
-npm run test:browser:watch  # Run in watch mode
-```
-
-### Combined Tests
-
-```bash
-npm test                    # Run both Node.js and browser tests
-npm run test:coverage       # Run both with coverage
-```
-
-## Test Frameworks & Libraries
-
-### Node.js Testing Stack
-
-- **@japa/runner** - Test runner
-- **@japa/assert** - Assertions
-- **@japa/api-client** - HTTP client for API testing
-- **@japa/expect-type** - TypeScript type testing
-- **sinon** - Mocking and spying
-- **c8** - Code coverage
-
-### Browser Testing Stack
-
-- **@web/test-runner** - Test runner
-- **@esm-bundle/chai** - Assertions for browser
-- **@web/test-runner-playwright** - Browser automation
-- **sinon** - Mocking (browser compatible)
-
-## Writing Tests
-
-### Node.js Tests Example
-
-```typescript
-import { test } from '@japa/runner'
-
-test.group('YourModule', (group) => {
-  group.each.setup(() => {
-    // Setup before each test
-  })
-
-  test('should do something', ({ assert }) => {
-    // Your test logic
-    assert.equal(actual, expected)
-  })
-})
-```
-
-### Browser Tests Example
-
-```typescript
-import { assert } from '@esm-bundle/chai'
-
-describe('YourModule', () => {
-  it('should work in browser', () => {
-    // Your browser test logic
-    assert.equal(actual, expected)
-  })
-})
-```
-
-## Test Environment Setup
-
-### OAuth2 Mock Server
-
-- Automatically starts on available port 8000-8100
-- Provides endpoints for various OAuth2 flows
-- Configured in `web-test-runner.config.js`
-
-### HTTP Servers
-
-- Express servers with CORS support
-- NTLM authentication support
-- Custom middleware for specific test scenarios
-
-## Test Plugins
-
-### Sinon Plugin
-
-```typescript
-test('should mock', ({ sinon, assert }) => {
-  const stub = sinon.stub(obj, 'method')
-  // ... test logic
-})
-```
-
-### Events Plugin
-
-```typescript
-test('should handle events', ({ events, assert }) => {
-  // Custom event testing logic
-})
-```
-
-## Configuration Files
-
-### TypeScript Configurations
-
-- `test/tsconfig.json` - Browser test compilation
-- `tests/tsconfig.json` - Node.js test compilation
-- `tsconfig.browser.json` - Browser build configuration
-- `tsconfig.node.json` - Node.js build configuration
-
-### Test Runner Configurations
-
-- `web-test-runner.config.js` - Browser test configuration
-- `bin/test.ts` - Japa test configuration
-
-## Running Specific Tests
-
-### Run specific test files
-
-```bash
-# Node.js specific file
-npm run test:node  -- --files=tests/unit/specific-test.spec.ts
-
-# Browser specific file
-npm run test:browser -- --files=test/specific-test.browser.test.ts
-```
-
-### Run tests with debugging
-
-```bash
-# Node.js with debugging
-node --inspect --import ts-node-maintained/register/esm bin/test.ts
-
-# Browser with debugging
-npm run test:browser -- --open --manual
-```
-
-## Coverage Reports
-
-Coverage is generated using **c8** for Node.js tests:
-
-- Reports in `lcov` and `text` formats
-- Configured to work with TypeScript source maps
-- Excludes test files and build artifacts
-
-## Best Practices
-
-1. **Separate browser and Node.js tests** - Use appropriate file naming
-2. **Use proper assertions** - Japa's assert for Node.js, Chai for browser
-3. **Mock external dependencies** - Use Sinon for consistent mocking
-4. **Test async code properly** - Use proper async/await patterns
-5. **Group related tests** - Use test groups for better organization
-
-## Troubleshooting
-
-### Common Issues
-
-1. **Port conflicts** - OAuth2 server uses dynamic ports
-2. **TypeScript compilation** - Check tsconfig files
-3. **Browser timeouts** - Increase timeout in web-test-runner config
-4. **Import issues** - Ensure proper ES module imports
-
-### Debug Tips
-
-1. Use `--watch` mode for development
-2. Check browser console for client-side errors
-3. Use `console.log` or debugger statements
-4. Verify mock server responses

package/Testing.md

@@ -1,21 +0,0 @@
-# Testing
-
-The core library contains code for node and a browser. It also contains UI components that use another testing framework. This document describes how testing works.
-
-## Node Testing
-
-We use Japa to run node tests. Node tests are under `./tests/**/*.spec.ts` directory.
-
-```sh
-npm run test:japa
-```
-
-## Browser Testing
-
-Most core libraries are also tested in the browser. We use the `@web/test-runner` package to perform these tests. These tests also cover UI and components.
-
-### WTR Limitations
-
-The web test runner requires an interactive mode to run. When using the watch mode we need to run two processes, one for compiling TS in watch mode, and the other to run tests in watch mode. This can't be done using `concurrently` as `concurrently` does not pass keyboard input to the process (perhaps a bug). There is an [https://github.com/modernweb-dev/web/issues/19](issue report) requesting to allow WTR running in non-interactive mode but for now we need to do this manually.
-
-This means, run the `build:watch` command in one terminal first, and then `test:watch-only` in the other.

package/amf-models/dialects/ApiProjectVocabulary.yaml

@@ -1,233 +0,0 @@
-#%Vocabulary 1.0
-
-vocabulary: api-project
-base: http://api-client.io/vocabularies/project#
-
-usage: |
-  The vocabulary definition of an API project.
-
-external:
-  schema-org: http://schema.org/
-
-classTerms:
-  Thing:
-    properties:
-    - extends
-  
-  ProjectFolder:
-    extends: Thing
-    properties:
-      - kind
-      - key
-      - info
-      - items
-      - environments
-      - updated
-      - created
-  ProjectItem:
-    extends: Thing
-    properties:
-      - kind
-      - key
-  Environment:
-    extends: Thing
-    properties:
-      - kind
-      - key
-      - encapsulated
-      - info
-      - server
-      - variables
-  Info:
-    extends: Thing
-    properties:
-      - kind
-      - version
-      - name
-      - description
-  Server:
-    extends: Thing
-    properties:
-      - kind
-      - uri
-      - protocol
-      - basePath
-      - description
-  Property:
-    extends: Thing
-    properties:
-      - kind
-      - name
-      - type
-      - enabled
-      - default
-      - enum
-      - description
-      - required
-  License:
-    extends: Thing
-    properties:
-      - kind
-      - url
-      - name
-      - content
-  Provider:
-    extends: Thing
-    properties:
-      - kind
-      - url
-      - name
-      - email
-  ProjectSchema:
-    extends: Thing
-    properties:
-      - kind
-      - key
-      - name
-      - content
-      - mime
-      - properties
-  HttpProject:
-    extends: Thing
-    properties:
-      - kind
-      - items
-      - provider
-      - info
-      - license
-  Request:
-    extends: Thing
-    properties:
-      - kind
-      - info
-      - expects
-      - log
-      - updated
-      - created
-      - midnight
-      - config
-      - authorization
-      - actions
-      - clientCertificate
-  ProjectRequest:
-    extends: Request
-    properties:
-      - key
-
-propertyTerms:
-  kind:
-    displayName: kind
-    range: string
-    description: The kind that identifies the object 
-  key:
-    displayName: key
-    range: string
-    description: The unique identifier of an object
-  updated:
-    displayName: updated
-    range: integer
-    description: The timestamp when the object was last updated
-  created:
-    displayName: created
-    range: integer
-    description: The timestamp when the object was created
-  items:
-    displayName: items
-    description: An item located in a project or a folder
-    range: ProjectItem
-  environments:
-    displayName: environments
-    description: The execution environment
-    range: Environment
-  info:
-    displayName: info
-    description: The base information about the object
-    range: Info
-  version:
-    displayName: version
-    range: schema-org.version
-    description: The version of the object
-  name:
-    displayName: name
-    range: schema-org.name
-    description: The name of the object
-  description:
-    displayName: description
-    range: schema-org.description
-    description: The description of the object
-  encapsulated:
-    displayName: encapsulated
-    range: boolean
-    description: Whether the object is encapsulated to its parent.
-  server:
-    displayName: server
-    range: Server
-    description: A server of an API
-  variables:
-    displayName: variables
-    range: Property
-    description: A list of properties in an environment
-  uri:
-    displayName: uri
-    range: string
-    description: The URI of a resource
-  url:
-    displayName: url
-    range: string
-    description: The URL of a resource
-  protocol:
-    displayName: protocol
-    range: string
-    description: The protocol used to construct an URL
-  basePath:
-    displayName: basePath
-    range: string
-    description: The API base path.
-  type:
-    displayName: type
-    range: string
-    description: The type of a property.
-  enabled:
-    displayName: enabled
-    range: boolean
-    description: Whether the property is allowed to be processed.
-  default:
-    displayName: default
-    range: any
-    description: The default value for a property
-  enum:
-    displayName: enum
-    range: any
-    description: The enum values for a property
-  required:
-    displayName: required
-    range: boolean
-    description: Whether the property is required.
-  content:
-    displayName: content
-    range: string
-    description: The rich content, usually used with a documents.
-  email:
-    displayName: email
-    range: string
-    description: The contact email to the person or the organization.
-  mime:
-    displayName: mime
-    range: string
-    description: The mime type of the object.
-  properties:
-    displayName: properties
-    range: Property
-    description: The list of properties in the object.
-  provider:
-    displayName: provider
-    range: Provider
-    description: The provider of the object.
-  license:
-    displayName: license
-    range: License
-    description: The license of the object.
-  midnight:
-    displayName: midnight
-    range: integer
-    description: The timestamp describing the midnight when an event happened.

package/amf-models/dialects/Environment.yaml

@@ -1,38 +0,0 @@
-#%Dialect 1.0
-
-dialect: Environment
-version: 1.0
-
-uses:
-  Thing: Thing.yaml
-  Server: Server.yaml
-  Property: Property.yaml
-  ApiProject: ApiProjectVocabulary.yaml
-
-documents:
-  root:
-    encodes: EnvironmentNode
-
-nodeMappings:
-  EnvironmentNode:
-    classTerm: ApiProject.Environment
-    mapping:
-      kind:
-        range: string
-        mandatory: true
-      key:
-        range: string
-        mandatory: true
-      encapsulated:
-        range: boolean
-        mandatory: false
-      info:
-        range: Thing.ThingNode
-        mandatory: true
-      server:
-        range: Server.ServerNode
-        mandatory: false
-      variables:
-        range: Property.PropertyNode
-        allowMultiple: true
-        mandatory: false

package/amf-models/dialects/HttpProject.yaml

@@ -1,55 +0,0 @@
-#%Dialect 1.0
-
-dialect: Http Project
-version: 1.0
-
-uses:
-  License: License.yaml
-  Thing: Thing.yaml
-  Provider: Provider.yaml
-  Environment: Environment.yaml
-  ProjectSchema: ProjectSchema.yaml
-  ProjectItem: ProjectItem.yaml
-  ProjectFolder: ProjectFolder.yaml
-  ProjectRequest: ProjectRequest.yaml
-  ApiProject: ApiProjectVocabulary.yaml
-
-documents:
-  root:
-    encodes: DescriptionDataNode
-
-nodeMappings:
-  DescriptionDataNode:
-    classTerm: ApiProject.HttpProject
-    mapping:
-      kind:
-        range: string
-        mandatory: true
-      definitions:
-        mandatory: true
-        allowMultiple: true
-        union:
-          - ProjectFolder.ProjectFolderNode
-          - ProjectRequest.ProjectRequestNode
-        typeDiscriminatorName: kind
-      items:
-        range: ProjectItem.ProjectItemNode
-        mandatory: true
-        allowMultiple: true
-      schemas:
-        range: ProjectSchema.ProjectSchemaNode
-        mandatory: false
-        allowMultiple: true
-      environments:
-        range: Environment.EnvironmentNode
-        mandatory: false
-        allowMultiple: true
-      provider:
-        range: Provider.ProviderNode
-        mandatory: false
-      info:
-        range: Thing.ThingNode
-        mandatory: false
-      license:
-        range: License.LicenseNode
-        mandatory: false

package/amf-models/dialects/License.yaml

@@ -1,31 +0,0 @@
-#%Dialect 1.0
-
-dialect: License
-version: 1.0
-
-uses:
-  ApiProject: ApiProjectVocabulary.yaml
-
-documents:
-  root:
-    encodes: LicenseNode
-
-nodeMappings:
-  LicenseNode:
-    classTerm: ApiProject.License
-    mapping:
-      kind:
-        propertyTerm: schema-org.name
-        range: string
-        mandatory: true
-      url:
-        propertyTerm: schema-org.url
-        range: string
-        mandatory: false
-      name:
-        propertyTerm: schema-org.name
-        range: string
-        mandatory: false
-      content:
-        range: string
-        mandatory: false

package/amf-models/dialects/ProjectFolder.yaml

@@ -1,43 +0,0 @@
-#%Dialect 1.0
-
-dialect: Project Folder
-version: 1.0
-
-uses:
-  Thing: Thing.yaml
-  ProjectItem: ProjectItem.yaml
-  Environment: Environment.yaml
-  ApiProject: ApiProjectVocabulary.yaml
-
-documents:
-  root:
-    encodes: ProjectFolderNode
-
-nodeMappings:
-  ProjectFolderNode:
-    classTerm: ApiProject.ProjectFolder
-    mapping:
-      kind:
-        range: string
-        mandatory: true
-      key:
-        propertyTerm: schema-org.identifier
-        range: string
-        mandatory: true
-      info:
-        range: Thing.ThingNode
-        mandatory: true
-      items:
-        range: ProjectItem.ProjectItemNode
-        mandatory: true
-        allowMultiple: true
-      environments:
-        range: Environment.EnvironmentNode
-        mandatory: false
-        allowMultiple: true
-      updated:
-        range: integer
-        mandatory: false
-      created:
-        range: integer
-        mandatory: false

package/amf-models/dialects/ProjectItem.yaml

@@ -1,22 +0,0 @@
-#%Dialect 1.0
-
-dialect: Project Item
-version: 1.0
-
-uses:
-  ApiProject: ApiProjectVocabulary.yaml
-
-documents:
-  root:
-    encodes: ProjectItemNode
-
-nodeMappings:
-  ProjectItemNode:
-    classTerm: ApiProject.ProjectItem
-    mapping:
-      kind:
-        range: string
-        mandatory: true
-      key:
-        range: string
-        mandatory: true

package/amf-models/dialects/ProjectRequest.yaml

@@ -1,23 +0,0 @@
-#%Dialect 1.0
-
-dialect: Project Request
-version: 1.0
-
-uses:
-  ApiProject: ApiProjectVocabulary.yaml
-
-documents:
-  root:
-    encodes: ProjectRequestNode
-
-nodeMappings:
-  ProjectRequestNode:
-    classTerm: ApiProject.ProjectRequest
-    mapping:
-      kind:
-        range: string
-        mandatory: true
-      key:
-        propertyTerm: schema-org.identifier
-        range: string
-        mandatory: true

package/amf-models/dialects/ProjectSchema.yaml

@@ -1,36 +0,0 @@
-#%Dialect 1.0
-
-dialect: Project Schema
-version: 1.0
-
-uses:
-  Property: Property.yaml
-  ApiProject: ApiProjectVocabulary.yaml
-
-documents:
-  root:
-    encodes: ProjectSchemaNode
-
-nodeMappings:
-  ProjectSchemaNode:
-    classTerm: ApiProject.ProjectSchema
-    mapping:
-      kind:
-        range: string
-        mandatory: true
-      key:
-        range: string
-        mandatory: true
-      name:
-        range: string
-        mandatory: false
-      content:
-        mandatory: false
-        range: string
-      mime:
-        mandatory: false
-        range: string
-      properties:
-        range: Property.PropertyNode
-        allowMultiple: true
-        mandatory: false