npmpackage.info

Gathering detailed insights and metrics for @suin/esa-exporter

@suin/esa-exporter

esa.io API から全データをエクスポートするライブラリ。

1.0.0

MIT

TypeScript

6.44 kB

414 2.5

Installations

npm install @suin/esa-exporter

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

12.21.0

NPM Version

6.14.11 Score

70.3

Supply Chain

95.2

Quality

74.9

Maintenance

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

v1.0.0

Published on 25 Mar 2021

View all 1 releases

Contributors

Unable to fetch Contributors

View all 2 contributors

Languages

TypeScript

TypeScript (100%)

Developer

suin

Download Statistics

Total Downloads

414

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

1 Stars

4 Commits

3 Watching

1 Branches

2 Contributors

Bundle Size

19.55 kB

Minified

6.44 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.0.0

Package Id

@suin/esa-exporter@1.0.0

Unpacked Size

20.05 kB

Size

6.62 kB

File Count

NPM Version

6.14.11

Node Version

12.21.0

Total Downloads

Cumulative downloads

Total Downloads

414

Last day

Compared to previous day

Last week

200%

Compared to previous week

Last month

50%

Compared to previous month

Last year

-3.9%

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@suin/esa-api

Dev Dependencies

@semantic-release/changelog @semantic-release/exec @semantic-release/git @types/jest husky jest lint-staged prettier semantic-release sort-package-json ts-jest typedoc typescript

Versions

@suin/esa-exporter

esa.io API から全データをエクスポートするライブラリ。

esa.io のエクスポート機能はマークダウンファイルがダウンロードできるだけで、他の情報が入ってこないためこれを開発しました。

特徴

エクスポートに対応しているデータ
- メンバー
- 投稿
  - コメント
  - stargazers

インストール

1yarn add @suin/esa-exporter
2# or
3npm install @suin/esa-exporter

使い方

基本的な用法:

1import { exportAll, Entity } from "@suin/esa-exporter";
2
3(async () => {
4  const team = process.env.ESA_TEAM;
5  const token = process.env.ESA_TOKEN;
6  const entities: Entity[] = [];
7
8  for await (const entity of exportAll({ team, token })) {
9    entities.push(entity);
10  }
11
12  console.log(entities);
13})();

出力例:

1[
2  {
3    $type: "member",
4    myself: true,
5    name: "Taro Tanaka",
6    screen_name: "tanaka",
7    icon:
8      "https://img.esa.io/uploads/production/users/1/icon/thumb_m_********.png",
9    role: "owner",
10    posts_count: 222,
11    joined_at: "2014-07-01T08:10:55+09:00",
12    last_accessed_at: "2019-12-27T16:23:23+09:00",
13    email: "tanaka@example.com",
14  },
15  {
16    $type: "member",
17    myself: false,
18    name: "Hanako Sato",
19    screen_name: "sato",
20    icon:
21      "https://img.esa.io/uploads/production/users/2/icon/thumb_m_********.jpg",
22    role: "owner",
23    posts_count: 111,
24    joined_at: "2014-07-01T08:19:26+09:00",
25    last_accessed_at: "2019-08-13T18:07:24+09:00",
26    email: "sato@example.com",
27  },
28  {
29    $type: "post",
30    number: 1,
31    name: "esa APIの使い方",
32    full_name: "日報/2015/05/09/esa APIの使い方 #api #dev",
33    wip: true,
34    body_md: "...",
35    body_html: "...",
36    created_at: "2015-05-09T11:54:50+09:00",
37    message: "初稿です！",
38    url: "https://example.esa.io/posts/1",
39    updated_at: "2015-05-09T11:54:51+09:00",
40    tags: ["api", "dev"],
41    category: "日報/2015/05/09",
42    revision_number: 1,
43    created_by: {
44      myself: true,
45      name: "Taro Tanaka",
46      screen_name: "tanaka",
47      icon:
48        "https://img.esa.io/uploads/production/users/1/icon/thumb_m_********.png",
49    },
50    updated_by: {
51      myself: true,
52      name: "Taro Tanaka",
53      screen_name: "tanaka",
54      icon:
55        "https://img.esa.io/uploads/production/users/1/icon/thumb_m_********.png",
56    },
57  },
58];

exportAllは様々なエンティティをごちゃまぜで返してくるので、エンティティ種別ごとに何らかの処理をする必要がある場合は、Entity[$type]で分岐処理を書いてください:

1import { exportAll, Member, Post } from "@suin/esa-exporter";
2
3(async () => {
4  const team = process.env.ESA_TEAM;
5  const token = process.env.ESA_TOKEN;
6
7  const members: Member[] = [];
8  const posts: Post[] = [];
9
10  for await (const entity of exportAll({ team, token })) {
11    switch (entity.$type) {
12      case "member":
13        members.push(entity);
14        break;
15      case "post":
16        posts.push(posts);
17        break;
18    }
19  }
20})();

API リファレンス

https://suin.github.io/esa-exporter/

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/suin/esa-exporter/build.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yaml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/suin/esa-exporter/build.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yaml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/suin/esa-exporter/build.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yaml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/suin/esa-exporter/build.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yaml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/suin/esa-exporter/build.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yaml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/suin/esa-exporter/build.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yaml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/suin/esa-exporter/build.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yaml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/suin/esa-exporter/build.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/suin/esa-exporter/build.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yaml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/suin/esa-exporter/build.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yaml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/suin/esa-exporter/build.yaml/main?enable=pin
Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 5 third-party GitHubAction dependencies pinned

0

SAST

Determines if the project uses static code analysis.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

39 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q

Score

2.5

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More