@wizardcontrollerprerelease/horseless-contentapi-lib v0.4.60

Horseless Content API

This library was generated with Angular CLI version 13.2.0.

Originally anyway. There should be nearly exactly reproducable steps docuemented here.

INSTRUCTIONS FOR LIBRARY EXTENSION

Code scaffolding

Run ng generate component component-name --project horseless-contentapi-lib to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project horseless-contentapi-lib.

Note: Don't forget to add --project horseless-contentapi-lib or else it will be added to the default project in your angular.json file.

Build

Run ng build horseless-contentapi-lib to build the project. The build artifacts will be stored in the dist/ directory.

Publishing

After building your library with ng build horseless-contentapi-lib, go to the dist folder cd dist/horseless-contentapi-lib and run npm publish.

Running unit tests

Run ng test horseless-contentapi-lib to execute the unit tests via Karma.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

INSTRUCTIONS FOR LIBRARY INSTALLATION AND CONSUMPTION

@wizardcontrollerprerelease/horseless-contentapi-lib

Building

To install the required dependencies and to build the typescript sources run:

npm install
npm run build

publishing

First build the package then run npm publish dist (don't forget to specify the dist folder!)

consuming

Navigate to the folder of your consuming project and run one of next commands.

published:

npm install @wizardcontrollerprerelease/horseless-contentapi-lib@v1 --save

without publishing (not recommended):

npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save

It's important to take the tgz file, otherwise you'll get trouble with links on windows

using npm link:

In PATH_TO_GENERATED_PACKAGE/dist:

npm link

In your project:

npm link @wizardcontrollerprerelease/horseless-contentapi-lib

Note for Windows users: The Angular CLI has troubles to use linked npm packages. Please refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround. Published packages are not effected by this issue.

General usage

In your Angular project:

// without configuring providers
import { ApiModule } from '@wizardcontrollerprerelease/horseless-contentapi-lib';
import { HttpClientModule } from '@angular/common/http';

@NgModule({
    imports: [
        ApiModule,
        // make sure to import the HttpClientModule in the AppModule only,
        // see https://github.com/angular/angular/issues/20575
        HttpClientModule
    ],
    declarations: [ AppComponent ],
    providers: [],
    bootstrap: [ AppComponent ]
})
export class AppModule {}

// configuring providers
import { ApiModule, Configuration, ConfigurationParameters } from '@wizardcontrollerprerelease/horseless-contentapi-lib';

export function apiConfigFactory (): Configuration {
  const params: ConfigurationParameters = {
    // set configuration parameters here.
  }
  return new Configuration(params);
}

@NgModule({
    imports: [ ApiModule.forRoot(apiConfigFactory) ],
    declarations: [ AppComponent ],
    providers: [],
    bootstrap: [ AppComponent ]
})
export class AppModule {}

// configuring providers with an authentication service that manages your access tokens
import { ApiModule, Configuration } from '@wizardcontrollerprerelease/horseless-contentapi-lib';

@NgModule({
    imports: [ ApiModule ],
    declarations: [ AppComponent ],
    providers: [
      {
        provide: Configuration,
        useFactory: (authService: AuthService) => new Configuration(
          {
            basePath: environment.apiUrl,
            accessToken: authService.getAccessToken.bind(authService)
          }
        ),
        deps: [AuthService],
        multi: false
      }
    ],
    bootstrap: [ AppComponent ]
})
export class AppModule {}

import { HorselessContentAPI } from '@wizardcontrollerprerelease/horseless-contentapi-lib';

export class AppComponent {
    constructor(private apiGateway: HorselessContentAPI) { }
}

Note: The ApiModule is restricted to being instantiated once app wide. This is to ensure that all services are treated as singletons.

Using multiple OpenAPI files / APIs / ApiModules

In order to use multiple ApiModules generated from different OpenAPI files, you can create an alias name when importing the modules in order to avoid naming conflicts:

import { ApiModule } from 'my-api-path';
import { ApiModule as OtherApiModule } from 'my-other-api-path';
import { HttpClientModule } from '@angular/common/http';

@NgModule({
  imports: [
    ApiModule,
    OtherApiModule,
    // make sure to import the HttpClientModule in the AppModule only,
    // see https://github.com/angular/angular/issues/20575
    HttpClientModule
  ]
})
export class AppModule {

}

Set service base path

If different than the generated base path, during app bootstrap, you can provide the base path to your service.

import { BASE_PATH } from '@wizardcontrollerprerelease/horseless-contentapi-lib';

bootstrap(AppComponent, [
    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
]);

or

import { BASE_PATH } from '@wizardcontrollerprerelease/horseless-contentapi-lib';

@NgModule({
    imports: [],
    declarations: [ AppComponent ],
    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
    bootstrap: [ AppComponent ]
})
export class AppModule {}

Using @angular/cli

First extend your src/environments/*.ts files by adding the corresponding base path:

export const environment = {
  production: false,
  API_BASE_PATH: 'http://127.0.0.1:8080'
};

In the src/app/app.module.ts:

import { BASE_PATH } from '@wizardcontrollerprerelease/horseless-contentapi-lib';
import { environment } from '../environments/environment';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [ ],
  providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],
  bootstrap: [ AppComponent ]
})
export class AppModule { }