Angular SDK

Squid を Angular application と統合するための library です。

SDK Version

Latest stable

Feature

• Squid Client SDK の初期化と injection を行う Angular module および provider

はじめに

要件

この SDK は、Angular documentation で示されている actively supported version の Angularのみをサポートします。その他の version にも互換性がある可能性がありますが、active にサポートされていません。

Installation

npm を使用する場合:

npm install @squidcloud/angular

Squid の設定

Squid Console を使用して Application を作成します。

• Angular root module で SquidModule を import し、Squid application ID と region を指定して設定します。

import { SquidModule } from '@squidcloud/angular';
// ...
@NgModule({
  // ...
  imports: [
    SquidModule.forRoot({
      appId: '<YOUR_APP_ID>',
      region: '<YOUR_SQUID_REGION>',
    }),
  ],
// ...

上記により、application のさまざまな service および component に inject できる Squid instance が提供されます。

または、factory function を使用して Squid instance を提供できます。

• Squid class と Squid factory provider を import します。

import { provideSquid } from '@squidcloud/angular';
import { Squid } from '@squidcloud/client';

• application の provider に provideSquid provider を追加します。

@NgModule({
  // ...
 providers: [
  {
     provide: Squid,
     useFactory: provideSquid({
       appId: '<YOUR_APP_ID>',
       region: '<YOUR_SQUID_REGION>',
     }),
    deps: [NgZone],
  },
],
// ...

この configuration により、同じ Angular application 内に複数の Squid instance を作成できます。 たとえば、Angular application に 2 つの Squid instance を作成できます。

export const usersSquidInjectionToken = new InjectionToken<Squid>('usersSquid');
export const billingSquidInjectionToken = new InjectionToken<Squid>('billingSquid');

@NgModule({
  // ...
 providers: [
  {
     provide: usersSquidInjectionToken,
     useFactory: provideSquid({
       appId: '<YOUR_APP_ID>',
       region: '<YOUR_SQUID_REGION>',
     }),
    deps: [NgZone],
  },
   {
     provide: billingSquidInjectionToken,
     useFactory: provideSquid({
       appId: '<YOUR_OTHER_APP_ID>',
       region: '<YOUR_OTHER_SQUID_REGION>',
     }),
     deps: [NgZone],
   },
 ],
// ...

Angular component で Squid client を使用する

import { Component } from '@angular/core';
import { Squid } from '@squidcloud/client';

@Component({
  selector: 'my-component',
  templateUrl: './my.component.html',
  styleUrls: ['./my.component.css'],
})
export class MyComponent {
  constructor(private readonly squid: Squid) {}
  // ...
}

Angular service で Squid client を使用する

import { Injectable } from '@angular/core';
import { Squid } from '@squidcloud/client';

@Injectable({ providedIn: 'root' })
export class MyService {
  constructor(private readonly squid: Squid) {}
  // ...
}

token を使用して Squid instance を提供した場合は、injection token を使用して inject することもできます。

import { Injectable, Inject } from '@angular/core';
import { Squid } from '@squidcloud/client';
import { usersSquidInjectionToken } from './my.module';

@injectable({ providedIn: 'root' })
export class MyService {
  constructor(@Inject(usersSquidInjectionToken) private readonly usersSquid: Squid) {}
  // ...
}

Squid を使用する component の完全な動作例:

import { Component } from '@angular/core';
import { Squid } from '@squidcloud/client';
import { map } from 'rxjs';

// Define your type
type User = { id: string; email: string; age: number };

@Component({
  selector: 'my-component',
  template: `
    <ul>
      <li *ngFor="let user of users | async">
        {{ user.email }}
      </li>
    </ul>
    <br />
    <button (click)="createNewUser()">Create user</button>
  `,
})
export class MyComponent {
  // Subscribe to data
  users = this.squid.collection<User>('Users').query().gt('age', 18).dereference().snapshots();

  constructor(private readonly squid: Squid) {}

  // Insert data
  async createNewUser(): Promise<void> {
    const userId = crypto.randomUUID();
    const email = `${userId}@gmail.com`;
    await this.squid
      .collection<User>('Users')
      .doc(userId)
      .insert({
        id: userId,
        email,
        age: Math.floor(Math.random() * 100),
      });
  }
}