github-schema 1.3.1 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -49,7 +49,7 @@ import { gqlTyped } from "github-schema";
49
49
  ## Editor Autocompletion
50
50
 
51
51
  > [!TIP]
52
- > You will need to have [GraphQL LSP](https://marketplace.visualstudio.com/items?itemName=GraphQL.vscode-graphql) installed, and have a `.graphqlrc.yaml` file in your project root.
52
+ > You will need to have [GraphQL LSP](https://marketplace.visualstudio.com/items?itemName=GraphQL.vscode-graphql) installed, and have a `.graphqlrc.yaml` file in your project root.
53
53
  > If you also want nice colors, i would recommend [GraphQL Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=GraphQL.vscode-graphql-syntax) installed.
54
54
 
55
55
  ```yaml
@@ -151,17 +151,32 @@ type AcceptEnterpriseAdministratorInvitationPayload = {
151
151
  type AcceptTopicSuggestionInput = {
152
152
  /** A unique identifier for the client performing the mutation. */
153
153
  clientMutationId?: InputMaybe<Scalars['String']['input']>;
154
- /** The name of the suggested topic. */
155
- name: Scalars['String']['input'];
156
- /** The Node ID of the repository. */
157
- repositoryId: Scalars['ID']['input'];
154
+ /**
155
+ * The name of the suggested topic.
156
+ *
157
+ * **Upcoming Change on 2024-04-01 UTC**
158
+ * **Description:** `name` will be removed.
159
+ * **Reason:** Suggested topics are no longer supported
160
+ */
161
+ name?: InputMaybe<Scalars['String']['input']>;
162
+ /**
163
+ * The Node ID of the repository.
164
+ *
165
+ * **Upcoming Change on 2024-04-01 UTC**
166
+ * **Description:** `repositoryId` will be removed.
167
+ * **Reason:** Suggested topics are no longer supported
168
+ */
169
+ repositoryId?: InputMaybe<Scalars['ID']['input']>;
158
170
  };
159
171
  /** Autogenerated return type of AcceptTopicSuggestion */
160
172
  type AcceptTopicSuggestionPayload = {
161
173
  __typename?: 'AcceptTopicSuggestionPayload';
162
174
  /** A unique identifier for the client performing the mutation. */
163
175
  clientMutationId?: Maybe<Scalars['String']['output']>;
164
- /** The accepted topic. */
176
+ /**
177
+ * The accepted topic.
178
+ * @deprecated Suggested topics are no longer supported Removal on 2024-04-01 UTC.
179
+ */
165
180
  topic?: Maybe<Topic>;
166
181
  };
167
182
  /** Represents an object which can take actions on GitHub. Typically a User or Bot. */
@@ -4196,19 +4211,40 @@ type CrossReferencedEvent = Node & UniformResourceLocatable & {
4196
4211
  type DeclineTopicSuggestionInput = {
4197
4212
  /** A unique identifier for the client performing the mutation. */
4198
4213
  clientMutationId?: InputMaybe<Scalars['String']['input']>;
4199
- /** The name of the suggested topic. */
4200
- name: Scalars['String']['input'];
4201
- /** The reason why the suggested topic is declined. */
4202
- reason: TopicSuggestionDeclineReason;
4203
- /** The Node ID of the repository. */
4204
- repositoryId: Scalars['ID']['input'];
4214
+ /**
4215
+ * The name of the suggested topic.
4216
+ *
4217
+ * **Upcoming Change on 2024-04-01 UTC**
4218
+ * **Description:** `name` will be removed.
4219
+ * **Reason:** Suggested topics are no longer supported
4220
+ */
4221
+ name?: InputMaybe<Scalars['String']['input']>;
4222
+ /**
4223
+ * The reason why the suggested topic is declined.
4224
+ *
4225
+ * **Upcoming Change on 2024-04-01 UTC**
4226
+ * **Description:** `reason` will be removed.
4227
+ * **Reason:** Suggested topics are no longer supported
4228
+ */
4229
+ reason?: InputMaybe<TopicSuggestionDeclineReason>;
4230
+ /**
4231
+ * The Node ID of the repository.
4232
+ *
4233
+ * **Upcoming Change on 2024-04-01 UTC**
4234
+ * **Description:** `repositoryId` will be removed.
4235
+ * **Reason:** Suggested topics are no longer supported
4236
+ */
4237
+ repositoryId?: InputMaybe<Scalars['ID']['input']>;
4205
4238
  };
4206
4239
  /** Autogenerated return type of DeclineTopicSuggestion */
4207
4240
  type DeclineTopicSuggestionPayload = {
4208
4241
  __typename?: 'DeclineTopicSuggestionPayload';
4209
4242
  /** A unique identifier for the client performing the mutation. */
4210
4243
  clientMutationId?: Maybe<Scalars['String']['output']>;
4211
- /** The declined topic. */
4244
+ /**
4245
+ * The declined topic.
4246
+ * @deprecated Suggested topics are no longer supported Removal on 2024-04-01 UTC.
4247
+ */
4212
4248
  topic?: Maybe<Topic>;
4213
4249
  };
4214
4250
  /** The possible base permissions for repositories. */
@@ -151,17 +151,32 @@ type AcceptEnterpriseAdministratorInvitationPayload = {
151
151
  type AcceptTopicSuggestionInput = {
152
152
  /** A unique identifier for the client performing the mutation. */
153
153
  clientMutationId?: InputMaybe<Scalars['String']['input']>;
154
- /** The name of the suggested topic. */
155
- name: Scalars['String']['input'];
156
- /** The Node ID of the repository. */
157
- repositoryId: Scalars['ID']['input'];
154
+ /**
155
+ * The name of the suggested topic.
156
+ *
157
+ * **Upcoming Change on 2024-04-01 UTC**
158
+ * **Description:** `name` will be removed.
159
+ * **Reason:** Suggested topics are no longer supported
160
+ */
161
+ name?: InputMaybe<Scalars['String']['input']>;
162
+ /**
163
+ * The Node ID of the repository.
164
+ *
165
+ * **Upcoming Change on 2024-04-01 UTC**
166
+ * **Description:** `repositoryId` will be removed.
167
+ * **Reason:** Suggested topics are no longer supported
168
+ */
169
+ repositoryId?: InputMaybe<Scalars['ID']['input']>;
158
170
  };
159
171
  /** Autogenerated return type of AcceptTopicSuggestion */
160
172
  type AcceptTopicSuggestionPayload = {
161
173
  __typename?: 'AcceptTopicSuggestionPayload';
162
174
  /** A unique identifier for the client performing the mutation. */
163
175
  clientMutationId?: Maybe<Scalars['String']['output']>;
164
- /** The accepted topic. */
176
+ /**
177
+ * The accepted topic.
178
+ * @deprecated Suggested topics are no longer supported Removal on 2024-04-01 UTC.
179
+ */
165
180
  topic?: Maybe<Topic>;
166
181
  };
167
182
  /** Represents an object which can take actions on GitHub. Typically a User or Bot. */
@@ -4196,19 +4211,40 @@ type CrossReferencedEvent = Node & UniformResourceLocatable & {
4196
4211
  type DeclineTopicSuggestionInput = {
4197
4212
  /** A unique identifier for the client performing the mutation. */
4198
4213
  clientMutationId?: InputMaybe<Scalars['String']['input']>;
4199
- /** The name of the suggested topic. */
4200
- name: Scalars['String']['input'];
4201
- /** The reason why the suggested topic is declined. */
4202
- reason: TopicSuggestionDeclineReason;
4203
- /** The Node ID of the repository. */
4204
- repositoryId: Scalars['ID']['input'];
4214
+ /**
4215
+ * The name of the suggested topic.
4216
+ *
4217
+ * **Upcoming Change on 2024-04-01 UTC**
4218
+ * **Description:** `name` will be removed.
4219
+ * **Reason:** Suggested topics are no longer supported
4220
+ */
4221
+ name?: InputMaybe<Scalars['String']['input']>;
4222
+ /**
4223
+ * The reason why the suggested topic is declined.
4224
+ *
4225
+ * **Upcoming Change on 2024-04-01 UTC**
4226
+ * **Description:** `reason` will be removed.
4227
+ * **Reason:** Suggested topics are no longer supported
4228
+ */
4229
+ reason?: InputMaybe<TopicSuggestionDeclineReason>;
4230
+ /**
4231
+ * The Node ID of the repository.
4232
+ *
4233
+ * **Upcoming Change on 2024-04-01 UTC**
4234
+ * **Description:** `repositoryId` will be removed.
4235
+ * **Reason:** Suggested topics are no longer supported
4236
+ */
4237
+ repositoryId?: InputMaybe<Scalars['ID']['input']>;
4205
4238
  };
4206
4239
  /** Autogenerated return type of DeclineTopicSuggestion */
4207
4240
  type DeclineTopicSuggestionPayload = {
4208
4241
  __typename?: 'DeclineTopicSuggestionPayload';
4209
4242
  /** A unique identifier for the client performing the mutation. */
4210
4243
  clientMutationId?: Maybe<Scalars['String']['output']>;
4211
- /** The declined topic. */
4244
+ /**
4245
+ * The declined topic.
4246
+ * @deprecated Suggested topics are no longer supported Removal on 2024-04-01 UTC.
4247
+ */
4212
4248
  topic?: Maybe<Topic>;
4213
4249
  };
4214
4250
  /** The possible base permissions for repositories. */
package/dist/index.cjs CHANGED
@@ -13,7 +13,7 @@ function gql(raw, ...keys) {
13
13
  return keys.length === 0 ? raw[0] : String.raw({ raw }, ...keys);
14
14
  }
15
15
 
16
- Object.defineProperty(exports, 'gqlTyped', {
16
+ Object.defineProperty(exports, "gqlTyped", {
17
17
  enumerable: true,
18
18
  get: function () { return graphqlTag__default.default; }
19
19
  });
@@ -108,13 +108,21 @@ input AcceptTopicSuggestionInput {
108
108
 
109
109
  """
110
110
  The name of the suggested topic.
111
+
112
+ **Upcoming Change on 2024-04-01 UTC**
113
+ **Description:** `name` will be removed.
114
+ **Reason:** Suggested topics are no longer supported
111
115
  """
112
- name: String!
116
+ name: String
113
117
 
114
118
  """
115
119
  The Node ID of the repository.
120
+
121
+ **Upcoming Change on 2024-04-01 UTC**
122
+ **Description:** `repositoryId` will be removed.
123
+ **Reason:** Suggested topics are no longer supported
116
124
  """
117
- repositoryId: ID!
125
+ repositoryId: ID
118
126
  }
119
127
 
120
128
  """
@@ -129,7 +137,7 @@ type AcceptTopicSuggestionPayload {
129
137
  """
130
138
  The accepted topic.
131
139
  """
132
- topic: Topic
140
+ topic: Topic @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
133
141
  }
134
142
 
135
143
  """
@@ -8631,18 +8639,30 @@ input DeclineTopicSuggestionInput {
8631
8639
 
8632
8640
  """
8633
8641
  The name of the suggested topic.
8642
+
8643
+ **Upcoming Change on 2024-04-01 UTC**
8644
+ **Description:** `name` will be removed.
8645
+ **Reason:** Suggested topics are no longer supported
8634
8646
  """
8635
- name: String!
8647
+ name: String
8636
8648
 
8637
8649
  """
8638
8650
  The reason why the suggested topic is declined.
8651
+
8652
+ **Upcoming Change on 2024-04-01 UTC**
8653
+ **Description:** `reason` will be removed.
8654
+ **Reason:** Suggested topics are no longer supported
8639
8655
  """
8640
- reason: TopicSuggestionDeclineReason!
8656
+ reason: TopicSuggestionDeclineReason
8641
8657
 
8642
8658
  """
8643
8659
  The Node ID of the repository.
8660
+
8661
+ **Upcoming Change on 2024-04-01 UTC**
8662
+ **Description:** `repositoryId` will be removed.
8663
+ **Reason:** Suggested topics are no longer supported
8644
8664
  """
8645
- repositoryId: ID!
8665
+ repositoryId: ID
8646
8666
  }
8647
8667
 
8648
8668
  """
@@ -8657,7 +8677,7 @@ type DeclineTopicSuggestionPayload {
8657
8677
  """
8658
8678
  The declined topic.
8659
8679
  """
8660
- topic: Topic
8680
+ topic: Topic @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
8661
8681
  }
8662
8682
 
8663
8683
  """
@@ -37356,7 +37376,11 @@ type Query {
37356
37376
  last: Int
37357
37377
 
37358
37378
  """
37359
- The search string to look for.
37379
+ The search string to look for. GitHub search syntax is supported. For more
37380
+ information, see "[Searching on
37381
+ GitHub](https://docs.github.com/search-github/searching-on-github),"
37382
+ "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax),"
37383
+ and "[Sorting search results](https://docs.github.com/search-github/getting-started-with-searching-on-github/sorting-search-results)."
37360
37384
  """
37361
37385
  query: String!
37362
37386
 
@@ -53742,22 +53766,22 @@ enum TopicSuggestionDeclineReason {
53742
53766
  """
53743
53767
  The suggested topic is not relevant to the repository.
53744
53768
  """
53745
- NOT_RELEVANT
53769
+ NOT_RELEVANT @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
53746
53770
 
53747
53771
  """
53748
53772
  The viewer does not like the suggested topic.
53749
53773
  """
53750
- PERSONAL_PREFERENCE
53774
+ PERSONAL_PREFERENCE @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
53751
53775
 
53752
53776
  """
53753
53777
  The suggested topic is too general for the repository.
53754
53778
  """
53755
- TOO_GENERAL
53779
+ TOO_GENERAL @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
53756
53780
 
53757
53781
  """
53758
53782
  The suggested topic is too specific for the repository (e.g. #ruby-on-rails-version-4-2-1).
53759
53783
  """
53760
- TOO_SPECIFIC
53784
+ TOO_SPECIFIC @deprecated(reason: "Suggested topics are no longer supported Removal on 2024-04-01 UTC.")
53761
53785
  }
53762
53786
 
53763
53787
  """
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "github-schema",
3
- "version": "1.3.1",
3
+ "version": "1.4.1",
4
4
  "description": "GitHub's GraphQL schema",
5
5
  "type": "module",
6
6
  "author": {
@@ -98,6 +98,7 @@
98
98
  "@luxass/eslint-config": "^4.0.0-beta.13",
99
99
  "@types/node": "^18.19.0",
100
100
  "eslint": "^8.54.0",
101
+ "eslint-plugin-format": "^0.1.0",
101
102
  "tsup": "^8.0.1",
102
103
  "typescript": "^5.3.2"
103
104
  }